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.

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

printout_reports

bool

When enabled, the printout reports are saved

MoveObjectsRequest#

Attribute Name

Data Type

Description

objects

ObjectList

direction_through

DirectionThrough

displacement_vector

Vector2d

axis

CoordinateAxis

create_copy

bool

number_of_steps

int

spacing

float

RotateObjectsRequest#

Attribute Name

Data Type

Description

objects

ObjectList

rotation_angle

float

point_1

Vector2d

create_copy

bool

number_of_steps

int

MirrorObjectsRequest#

Attribute Name

Data Type

Description

objects

ObjectList

mirroring_type

MirroringAxisSpecificationType

point_1

Vector2d

point_2

Vector2d

axis

CoordinateAxis

create_copy

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.