GetObjectIdListRequest

Attribute Name	Data Type	Description
object_type	ObjectType	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	ModelId	Unique identifier of the model. If not specified, the active model is used.

Associated Data Types

BaseDataRequest

Attribute Name	Data Type	Description
base_data	BaseData
model_id	ModelId	Unique identifier of the model. If not specified, the active model is used.

GlobalSettingsTreeTable

Attribute Name	Data Type	Description
rows	List[GlobalSettingsRow]

GlobalSettingsRow

Attribute Name	Data Type	Description
key	str
caption	str
symbol	str
value	Value
unit	str
rows	List[GlobalSettingsRow]

GetDesignSettingsRequest

Attribute Name	Data Type	Description
addon	DesignAddons
model_id	ModelId	Unique identifier of the model. Active model is used if this field is not set.

SetDesignSettingsRequest

Attribute Name	Data Type	Description
addon	DesignAddons
global_settings_tree_table	GlobalSettingsTreeTable
model_id	ModelId	Unique identifier of the model. Active model is used if this field is not set.

HasResultsRequest

Attribute Name	Data Type	Description
loading	ObjectId	Allowed types: OBJECT_TYPE_CONSTRUCTION_STAGE, OBJECT_TYPE_DESIGN_SITUATION, OBJECT_TYPE_LOAD_CASE, OBJECT_TYPE_LOAD_COMBINATION, OBJECT_TYPE_RESULT_COMBINATION
model_id	ModelId	Unique identifier of the model. Active model is used if this field is not set.

GetResultContourRequest

Attribute Name	Data Type	Description
results_type	ResultsType
contour_type	ContourType
filters	List[ResultsFilter]
model_id	ModelId	Unique identifier of the model. Active model is used if this field is not set.

GetResultTableRequest

Attribute Name	Data Type	Description
table	ResultTable
loading	ObjectId	Allowed types: OBJECT_TYPE_CONSTRUCTION_STAGE, OBJECT_TYPE_DESIGN_SITUATION, OBJECT_TYPE_LOAD_CASE, OBJECT_TYPE_LOAD_COMBINATION, OBJECT_TYPE_RESULT_COMBINATION
model_id	ModelId	Unique identifier of the model. Active model is used if this field is not set.
member_axes_system	MemberAxesSystem	Specifies Member Axes System of the results
support_coordinate_system	CoordinateSystem	Specifies Support Coordinate System of the results

CalculateSpecificRequest

Attribute Name	Data Type	Description
loadings	List[ObjectId]	Unique identifier of the loading.
skip_warnings	bool	Specifies whether to skip warnings during the calculation.
model_id	ModelId	Unique identifier of the model. Active model is used if this field is not set.

SetMeshSettingsRequest

Attribute Name	Data Type	Description
mesh_settings	MeshSettings
model_id	ModelId	Unique identifier of the model. Active model is used if this field is not set.

GenerateMeshRequest

Attribute Name	Data Type	Description
skip_warnings	bool	Specifies whether to skip warnings during the generation mesh.
model_id	ModelId	Unique identifier of the model. Active model is used if this field is not set.

CreatePrintoutReportRequest

Attribute Name	Data Type	Description
name	str	Name of the new printout report.
load_from_template	str	Name of the template used to create the new printout report. If not specified, the printout report is created without a template.
model_id	ModelId	Unique identifier of the model. Active model is used if this field is not set.

PrintoutReportInfo

Attribute Name	Data Type	Description
id	int
name	str

PrintoutReportInfoList

Attribute Name	Data Type	Description
printout_report_info	List[PrintoutReportInfo]

SaveModelAsRequest

Attribute Name	Data Type	Description
model_id	ModelId	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
fe_mesh	bool	When enabled, the model is saved together with the FE Mesh
printout_reports	bool	When enabled, the printout reports are saved

MoveObjectsRequest

Attribute Name	Data Type	Description
objects	ObjectList
direction_through	DirectionThrough
displacement_vector	Vector3d
axis	CoordinateAxis
coordinate_system	int
create_copy	bool
number_of_steps	int
spacing	float
copy_including_loading	bool
copy_including_imperfections	bool
connect_lines_members_surfaces	bool

RotateObjectsRequest

Attribute Name	Data Type	Description
objects	ObjectList
rotation_angle	float
rotation_axis	RotationAxisSpecificationType
point_1	Vector3d
point_2	Vector3d
axis	CoordinateAxis
coordinate_system	int
create_copy	bool
number_of_steps	int
copy_including_loading	bool
copy_including_imperfections	bool
connect_lines_members_surfaces	bool
rotate_local_coordinate_systems_of_lines_members	bool
adjust_loading_nodal_loads	bool

MirrorObjectsRequest

Attribute Name	Data Type	Description
objects	ObjectList
mirroring_type	MirroringPlaneSpecificationType
point_1	Vector3d
point_2	Vector3d
point_3	Vector3d
plane	Plane
coordinate_system	int
create_copy	bool
copy_including_loading	bool
copy_including_imperfections	bool
connect_lines_members_surfaces	bool
rotate_local_coordinate_systems_of_lines_members	bool
adjust_loading_nodal_loads	bool

GetObjectTableRequest

Attribute Name	Data Type	Description
object_type	ObjectType
model_id	ModelId	Unique identifier of the model. Active model is used if this field is not set.
use_current_units	bool	Identifier whether user defined or SI units are used to represent values
return_formulas	bool	Identifier whether the formulas should be returned instead of values
loading	ObjectId	Identifier of the load case used to scope the table content. Allowed types: OBJECT_TYPE_LOAD_CASE.