common_messages#
CreateModelRequest#
Attribute Name |
Data Type |
Description |
|---|---|---|
name |
str |
Name of the new model |
template_path |
str |
Path to the existing template to be opened |
OpenModelRequest#
Attribute Name |
Data Type |
Description |
|---|---|---|
path |
str |
Path to the existing model to be opened |
CloseModelRequest#
Attribute Name |
Data Type |
Description |
|---|---|---|
save_changes |
bool |
Specifies whether to save changes before closing the model |
model_id |
Unique identifier of the model Active model is used if this field is not set. |
CloseAllModelsRequest#
Attribute Name |
Data Type |
Description |
|---|---|---|
save_changes |
bool |
Specifies whether to save changes before closing the models |
ModelInfo#
Attribute Name |
Data Type |
Description |
|---|---|---|
name |
str |
Name of the model |
guid |
str |
Unique identifier of the model |
path |
str |
Path to where the model is saved. It is not set if the model is not saved on a disk. |
ModelList#
Attribute Name |
Data Type |
Description |
|---|---|---|
model_info |
List[ModelInfo] |
List of models and information about them |
ApplicationInfo#
Attribute Name |
Data Type |
Description |
|---|---|---|
name |
str |
Full application name |
type |
Application type |
|
is_server_instance |
bool |
Specifies whether the application is server instance or GUI application |
version |
str |
Application version (e.g. 6.07.0007) |
full_version |
str |
Application full version (e.g. 6.07.0007.163.bd0dfc604b5) |
options |
str |
Application options (e.g. Developer, Prerelease) |
language_name |
str |
Full language name (e.g. English) |
language_id |
str |
Language identificator (e.g. en) |
SubscriptionInfo#
Attribute Name |
Data Type |
Description |
|---|---|---|
api_requests_count |
int |
Total number of API requests for the current month |
api_requests_limit |
int |
Total of API requests according to the subscription |
subscription_plan |
str |
Subscription plan of the current company |
Object#
Attribute Name |
Data Type |
Description |
|---|---|---|
object |
google.protobuf.Any |
|
model_id |
Unique identifier of the model. Active model is used if this field is not set. |
ObjectList#
PlausibilityCheckRequest#
Attribute Name |
Data Type |
Description |
|---|---|---|
type |
Specifies various validation checks that can be performed before generating a mesh, running a calculation, or verifying plausibility. |
|
skip_warnings |
bool |
Specifies whether to skip warnings during the calculation. |
model_id |
Unique identifier of the model. Active model is used if this field is not set. |
CalculateAllRequest#
Attribute Name |
Data Type |
Description |
|---|---|---|
skip_warnings |
bool |
Specifies whether to skip warnings during the calculation. |
model_id |
Unique identifier of the model. Active model is used if this field is not set. |
OperationResult#
Attribute Name |
Data Type |
Description |
|---|---|---|
succeeded |
bool |
Indicates whether the operation was successful. |
data |
str |
Description of the result. |
message |
str |
Additional error information. Specifies the error or provides advice on how to resolve it. |
ModelMainParameters#
Attribute Name |
Data Type |
Description |
|---|---|---|
model_id |
str |
|
model_name |
str |
|
model_description |
str |
|
model_comment |
str |
|
model_path |
str |
|
project_id |
str |
|
project_name |
str |
|
project_description |
str |
|
project_folder |
str |
ConvertObjectsRequest#
Attribute Name |
Data Type |
Description |
|---|---|---|
convert_into |
Specifies conversion type |
|
objects |
Objects to be converted |
ImportRequest#
Attribute Name |
Data Type |
Description |
|---|---|---|
filepath |
str |
Path to the file to be imported |
import_attributes |
google.protobuf.Any |
Import attributes. This message specifies the format and attributes of the import. Supported message types: import_export.IfcImportAttributes, import_export.RsectionImportAttributes, import_export.XmlImportAttributes |
model_id |
Unique identifier of the model. If not specified, the active model is used. |
ExportRequest#
Attribute Name |
Data Type |
Description |
|---|---|---|
filepath |
str |
Path of the file for export. |
export_attributes |
google.protobuf.Any |
Export attributes. This message specifies the format and attributes of the export. Supported message types: import_export.PythonGrpcExportAttributes, import_export.IfcExportAttributes |
model_id |
Unique identifier of the model. If not specified, the active model is used. |
GetObjectListRequest#
Attribute Name |
Data Type |
Description |
|---|---|---|
objects |
||
return_only_selected_objects |
bool |
If true, only selected objects will be returned. |
Associated Enums
ApplicationType#
Name |
|---|
APPLICATION_UNSPECIFIED |
APPLICATION_DLUBAL_CENTER |
APPLICATION_REPORT_VIEWER |
APPLICATION_RFEM |
APPLICATION_RSTAB |
APPLICATION_RSECTION |
APPLICATION_WEB_SECTIONS |
APPLICATION_CRASH_REPORTER |
PlausibilityCheckType#
Name |
|---|
PLAUSIBILITY_CHECK_UNSPECIFIED |
PLAUSIBILITY_CHECK_MESH_GENERATOR |
PLAUSIBILITY_CHECK_CALCULATION |
PLAUSIBILITY_CHECK_PLAUSIBILITY_CHECK |
PLAUSIBILITY_CHECK_PART_LIST |
ConvertObjectInto#
Name |
|---|
CONVERT_OBJECT_INTO_UNSPECIFIED |
CONVERT_IFC_OBJECT_INTO_STRAIGHT_MEMBER |
CONVERT_IFC_OBJECT_INTO_CURVED_MEMBER |
CONVERT_IFC_OBJECT_INTO_SURFACE |
CONVERT_IFC_OBJECT_INTO_SOLID |