openapi: 3.0.4
info:
contact:
email: info@ideastatica.com
name: IDEA StatiCa
url: https://github.com/idea-statica/ideastatica-public
description: "IDEA StatiCa Connection API, used for the automated design and calculation\
\ of steel connections."
license:
name: IDEA StatiCa License
url: https://github.com/idea-statica/ideastatica-public/blob/main/LICENSE
termsOfService: https://www.ideastatica.com/end-user-license-agreement
title: Connection Rest API 3.0
version: "3.0"
servers:
- url: /
paths:
/api/3/projects/{projectId}/connections/calculate:
post:
operationId: Calculate
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
content:
application/json:
schema:
items:
format: int32
type: integer
type: array
description: List of connection IDs to calculate.
required: true
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ConResultSummary'
type: array
description: OK
summary: Runs CBFEM calculation and returns the summary of the results.
tags:
- Calculation
x-requiresProject: true
x-requiresConnection: false
/api/3/projects/{projectId}/connections/results:
post:
operationId: GetResults
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
content:
application/json:
schema:
items:
format: int32
type: integer
type: array
description: List of connection IDs to calculate.
required: true
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ConnectionCheckRes'
type: array
description: OK
summary: Gets detailed results of the CBFEM analysis.
tags:
- Calculation
x-requiresProject: true
x-requiresConnection: false
/api/3/projects/{projectId}/connections/rawresults-text:
post:
description: "\r\nBolt identifiers: Bolt keys in the raw results\
\ (e.g., in `boltCheckResDataTimbers`)\r\n are opaque internal\
\ CBFEM solver identifiers. They may start at any number, are not necessarily\
\ sequential,\r\n and may contain gaps. When a user explodes a\
\ bolt group or modifies bolt positions, the identifiers may shift.\r\n \
\ Do not assume bolt keys start at 1 or can be used as array indices.\
\ To map bolts to sequential positions,\r\n sort the keys numerically\
\ and use the resulting order.\r\n\r\n\r\n `forcesAllLoadCases`\
\ dictionary keys: In the per-bolt results within\r\n \
\ `boltCheckResDataTimbers`, the `forcesAllLoadCases` dictionary is keyed\
\ by the\r\n load case's internal numeric identifier (as a string).\
\ The key is not always `\"1\"`\r\n — it corresponds to\
\ the load case ID. For example, if only load case LE2 is active,\r\n \
\ the sole key will be `\"2\"`. API consumers should iterate over available\
\ keys\r\n rather than assuming a specific key value."
operationId: GetRawJsonResults
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
content:
application/json:
schema:
items:
format: int32
type: integer
type: array
description: List of connection IDs to calculate.
required: true
responses:
"200":
content:
application/json:
schema:
items:
type: string
type: array
description: OK
summary: Gets JSON string which represents raw CBFEM results (an instance of
CheckResultsData).
tags:
- Calculation
x-requiresProject: true
x-requiresConnection: false
/api/3/clients/connect-client:
get:
operationId: ConnectClient
responses:
"200":
content:
text/plain:
schema:
type: string
application/json:
schema:
type: string
description: OK
summary: Connects a client to the ConnectionRestApi service and returns a unique
identifier for the client.
tags:
- Client
x-requiresProject: false
x-requiresConnection: false
/api/3/clients/idea-service-version:
get:
operationId: GetVersion
responses:
"200":
content:
application/json:
schema:
type: string
description: OK
summary: Gets the IdeaStatica API assembly version.
tags:
- Client
x-requiresProject: false
x-requiresConnection: false
/api/3/projects/{projectId}/connections:
get:
operationId: GetConnections
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ConConnection'
type: array
description: OK
summary: Gets data about all connections in the project.
tags:
- Connection
x-requiresProject: true
x-requiresConnection: false
post:
operationId: CreateEmptyConnection
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: "Optional connection name. If null or empty, a default name `CON{newId}`\
\ is assigned."
explode: true
in: query
name: name
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConConnection'
description: OK
summary: Adds a new empty connection to the project.
tags:
- Connection
x-requiresProject: true
x-requiresConnection: false
/api/3/projects/{projectId}/connections/{connectionId}:
delete:
operationId: DeleteConnection
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection to delete.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ConConnection'
type: array
description: OK
summary: Deletes a specific connection from the project.
tags:
- Connection
x-requiresProject: true
x-requiresConnection: true
get:
operationId: GetConnection
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the requested connection.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConConnection'
description: OK
summary: Gets data about a specific connection in the project.
tags:
- Connection
x-requiresProject: true
x-requiresConnection: true
put:
operationId: UpdateConnection
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection to be updated.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConConnection'
description: New connection data to be applied.
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConConnection'
description: OK
summary: Updates data of a specific connection in the project.
tags:
- Connection
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/copy:
post:
operationId: CopyConnection
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the source connection to copy.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
- description: "Optional name for the new connection. If null or empty, a unique\
\ name is derived from the source connection name."
explode: true
in: query
name: name
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConConnection'
description: OK
summary: Creates a copy of an existing connection in the project.
tags:
- Connection
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/production-cost:
get:
operationId: GetProductionCost
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the requested connection.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConProductionCost'
description: OK
summary: Gets the production cost of the connection.
tags:
- Connection
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/get-topology:
get:
operationId: GetConnectionTopology
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection for which to retrieve the topology.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
text/plain:
schema:
type: string
application/json:
schema:
type: string
description: OK
summary: Gets the topology of the connection in JSON format.
tags:
- Connection
x-requiresProject: true
x-requiresConnection: true
/api/3/connection-library/get-design-sets:
get:
description: "This method returns a collection of design sets that are mapped\
\ and ready for use. It throws an\r\n exception if no design sets\
\ are available for the user."
operationId: GetDesignSets
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ConDesignSet'
type: array
description: OK
summary: Retrieves a list of design sets available for the user.
tags:
- ConnectionLibrary
x-requiresProject: false
x-requiresConnection: false
/api/3/projects/{projectId}/connections/{connectionId}/propose:
post:
description: "This method retrieves the connection model from the specified\
\ project and classifies its\r\n typology. It then filters and\
\ proposes design items based on the connection's typology and design code."
operationId: Propose
parameters:
- description: The unique identifier of the project containing the connection.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The identifier of the connection for which design items are proposed.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConConnectionLibrarySearchParameters'
description: "Parameters used to filter and refine the search for proposed\
\ connection design items, such as set membership and required connection\
\ features."
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ConDesignItem'
type: array
description: OK
summary: Proposes a list of design items for a specified connection within a
project.
tags:
- ConnectionLibrary
x-requiresProject: true
x-requiresConnection: true
/api/3/connection-library/get-template:
get:
description: "This method is mapped to API version 2 and produces a plain text\
\ response. It is intended to be\r\n used in scenarios where the\
\ template of a design item needs to be retrieved for further processing or\r\
\n display."
operationId: GetTemplate
parameters:
- description: The unique identifier of the design set.
explode: true
in: query
name: designSetId
required: false
schema:
format: uuid
type: string
style: form
- description: The unique identifier of the design item for which the template
is requested.
explode: true
in: query
name: designItemId
required: false
schema:
format: uuid
type: string
style: form
responses:
"200":
content:
text/plain:
schema:
type: string
description: OK
summary: Retrieves the template associated with the specified design set and
design item.
tags:
- ConnectionLibrary
x-requiresProject: false
x-requiresConnection: false
/api/3/connection-library/get-picture:
get:
description: "This method is mapped to API version 2 and produces a PNG image.\
\ The image is returned as a file\r\n stream result with the file\
\ name set to the design item's ID."
operationId: GetDesignItemPicture
parameters:
- description: The unique identifier of the design set.
explode: true
in: query
name: designSetId
required: false
schema:
format: uuid
type: string
style: form
- description: The unique identifier of the design item for which the template
is requested.
explode: true
in: query
name: designItemId
required: false
schema:
format: uuid
type: string
style: form
responses:
"200":
description: OK
summary: Retrieves the picture associated with the specified design item as
a PNG image.
tags:
- ConnectionLibrary
x-requiresProject: false
x-requiresConnection: false
/api/3/projects/{projectId}/connections/{connectionId}/publish:
post:
operationId: PublishConnection
parameters:
- description: ""
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: ""
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConTemplatePublishParam'
description: ""
responses:
"200":
content:
application/json:
schema:
type: boolean
description: OK
summary: Publish template to Private or Company set
tags:
- ConnectionLibrary
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/get-default-mapping:
get:
operationId: GetConversionMapping
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service (only ECEN design code is supported).
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The requested design code for the converted project.
explode: true
in: query
name: countryCode
required: false
schema:
$ref: '#/components/schemas/CountryCode'
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConConversionSettings'
description: OK
summary: Gets default conversion mappings for converting the project to a different
design code.
tags:
- Conversion
x-requiresProject: true
x-requiresConnection: false
/api/3/projects/{projectId}/change-code:
post:
operationId: ChangeCode
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service (only ECEN projects are supported).
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConConversionSettings'
description: Conversion table for materials in the project (pairs 'ECEN MATERIAL'
to 'TARGET DESIGN CODE MATERIAL').
responses:
"200":
content:
application/json:
schema:
type: string
description: OK
summary: Changes the design code of the project.
tags:
- Conversion
x-requiresProject: true
x-requiresConnection: false
/api/3/projects/{projectId}/connections/{connectionId}/export-iom:
get:
operationId: ExportIom
parameters:
- description: The unique identifier of the opened project.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection to export.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
- description: Optional version string for downgrading the IOM model.
explode: true
in: query
name: version
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/xml:
schema:
type: string
text/plain:
schema:
type: string
description: OK
summary: Exports the connection to XML which includes the OpenModelContainer
(https://github.com/idea-statica/ideastatica-public/blob/main/src/IdeaRS.OpenModel/OpenModelContainer.cs).
tags:
- Export
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/export-iom-connection-data:
get:
operationId: ExportIomConnectionData
parameters:
- description: The unique identifier of the opened project.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection to export.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectionData'
application/xml:
schema:
$ref: '#/components/schemas/ConnectionData'
description: OK
summary: Gets the ConnectionData for the specified connection (https://github.com/idea-statica/ideastatica-public/blob/main/src/IdeaRS.OpenModel/Connection/ConnectionData.cs).
tags:
- Export
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/export-ifc:
get:
operationId: ExportIFC
parameters:
- description: The unique identifier of the opened project.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection to export.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
text/plain:
schema:
type: string
description: OK
summary: Exports the connection to IFC format.
tags:
- Export
x-requiresProject: true
x-requiresConnection: true
x-extensionMethodName: ExportIfcFile
/api/3/projects/{projectId}/connections/{connectionId}/load-effects:
get:
operationId: GetLoadEffects
parameters:
- description: The unique identifier of the opened project.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
- description: Optional flag indicating whether to return percentage-based load
effects.
explode: true
in: query
name: isPercentage
required: false
schema:
type: boolean
style: form
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ConLoadEffect'
type: array
description: OK
summary: Gets all load effects defined in the specified connection.
tags:
- LoadEffect
x-requiresProject: true
x-requiresConnection: true
post:
operationId: AddLoadEffect
parameters:
- description: The unique identifier of the opened project.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConLoadEffect'
description: The load effect data to add.
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConLoadEffect'
description: OK
summary: Adds a new load effect to the connection.
tags:
- LoadEffect
x-requiresProject: true
x-requiresConnection: true
put:
operationId: UpdateLoadEffect
parameters:
- description: ""
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: ""
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConLoadEffect'
description: ""
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConLoadEffect'
description: OK
summary: Update load impulses in conLoading
tags:
- LoadEffect
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/load-effects/{loadEffectId}:
delete:
operationId: DeleteLoadEffect
parameters:
- description: ""
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: ""
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
- description: ""
explode: false
in: path
name: loadEffectId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
application/json:
schema:
format: int32
type: integer
description: OK
summary: Delete load effect loadEffectId
tags:
- LoadEffect
x-requiresProject: true
x-requiresConnection: true
get:
operationId: GetLoadEffect
parameters:
- description: The unique identifier of the opened project.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
- description: The ID of the load effect to retrieve.
explode: false
in: path
name: loadEffectId
required: true
schema:
format: int32
type: integer
style: simple
- description: Optional flag indicating whether to return percentage-based load
effects.
explode: true
in: query
name: isPercentage
required: false
schema:
type: boolean
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConLoadEffect'
description: OK
summary: Gets load impulses from the specified load effect.
tags:
- LoadEffect
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/load-effects/get-load-settings:
get:
operationId: GetLoadSettings
parameters:
- description: ""
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: ""
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConLoadSettings'
description: OK
summary: Get Load settings for connection in project
tags:
- LoadEffect
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/load-effects/set-load-settings:
post:
operationId: SetLoadSettings
parameters:
- description: ""
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: ""
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConLoadSettings'
description: ""
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConLoadSettings'
description: OK
summary: Set Load settings for connection in project
tags:
- LoadEffect
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/materials:
get:
operationId: GetAllMaterials
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
items: {}
type: array
description: OK
summary: Gets materials used in the specified project.
tags:
- Material
x-requiresProject: true
x-requiresConnection: false
/api/3/projects/{projectId}/materials/steel:
get:
operationId: GetSteelMaterials
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
items: {}
type: array
description: OK
summary: Gets materials used in the specified project.
tags:
- Material
x-requiresProject: true
x-requiresConnection: false
post:
operationId: AddMaterialSteel
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConMprlElement'
description: Definition of the new material to be added to the project.
responses:
"200":
description: OK
summary: Adds a material to the project.
tags:
- Material
x-requiresProject: true
x-requiresConnection: false
/api/3/projects/{projectId}/materials/concrete:
get:
operationId: GetConcreteMaterials
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
items: {}
type: array
description: OK
summary: Gets materials used in the specified project.
tags:
- Material
x-requiresProject: true
x-requiresConnection: false
post:
operationId: AddMaterialConcrete
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConMprlElement'
description: Definition of the new material to be added to the project.
responses:
"200":
description: OK
summary: Adds a material to the project.
tags:
- Material
x-requiresProject: true
x-requiresConnection: false
/api/3/projects/{projectId}/materials/bolt-grade:
get:
operationId: GetBoltGradeMaterials
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
items: {}
type: array
description: OK
summary: Gets materials used in the specified project.
tags:
- Material
x-requiresProject: true
x-requiresConnection: false
post:
operationId: AddMaterialBoltGrade
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConMprlElement'
description: Definition of the new material to be added to the project.
responses:
"200":
description: OK
summary: Adds a material to the project.
tags:
- Material
x-requiresProject: true
x-requiresConnection: false
/api/3/projects/{projectId}/materials/welding:
get:
operationId: GetWeldingMaterials
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
items: {}
type: array
description: OK
summary: Gets materials used in the specified project.
tags:
- Material
x-requiresProject: true
x-requiresConnection: false
post:
operationId: AddMaterialWeld
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConMprlElement'
description: Definition of the new material to be added to the project.
responses:
"200":
description: OK
summary: Adds a material to the project.
tags:
- Material
x-requiresProject: true
x-requiresConnection: false
/api/3/projects/{projectId}/materials/headed-stud-grade:
get:
operationId: GetHeadedStudGradeMaterials
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
items: {}
type: array
description: OK
summary: Gets materials used in the specified project.
tags:
- Material
x-requiresProject: true
x-requiresConnection: false
post:
operationId: AddMaterialHeadedStudGrade
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConMprlElement'
description: Definition of the new material to be added to the project.
responses:
"200":
description: OK
summary: Adds a material to the project.
tags:
- Material
x-requiresProject: true
x-requiresConnection: false
/api/3/projects/{projectId}/materials/cross-sections:
get:
operationId: GetCrossSections
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
items: {}
type: array
description: OK
summary: Gets cross sections used in the specified project.
tags:
- Material
x-requiresProject: true
x-requiresConnection: false
post:
operationId: AddCrossSection
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConMprlCrossSection'
description: Definition of a new cross-section to be added to the project
responses:
"200":
description: OK
summary: Add cross section to the project
tags:
- Material
x-requiresProject: true
x-requiresConnection: false
/api/3/projects/{projectId}/materials/bolt-assemblies:
get:
operationId: GetBoltAssemblies
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
items: {}
type: array
description: OK
summary: Gets bolt assemblies used in the specified project.
tags:
- Material
x-requiresProject: true
x-requiresConnection: false
post:
operationId: AddBoltAssembly
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConMprlElement'
description: Definition of a new bolt assemby to be added to the project
responses:
"200":
description: OK
summary: Add bolt assembly to the project
tags:
- Material
x-requiresProject: true
x-requiresConnection: false
/api/3/projects/{projectId}/connections/{connectionId}/members:
get:
operationId: GetMembers
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection from which to retrieve members.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ConMember'
type: array
description: OK
summary: Gets information about all members in the connection.
tags:
- Member
x-requiresProject: true
x-requiresConnection: true
post:
operationId: AddMember
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection to add the member to.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConMember'
description: The member data for the new member.
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConMember'
description: OK
summary: Adds a new member to the connection.
tags:
- Member
x-requiresProject: true
x-requiresConnection: true
put:
operationId: UpdateMember
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection containing the member to update.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConMember'
description: The new member data to apply.
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConMember'
description: OK
summary: Updates the member in the connection with the provided data.
tags:
- Member
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/members/{memberId}:
get:
operationId: GetMember
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection containing the member.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
- description: The ID of the requested member in the connection.
explode: false
in: path
name: memberId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConMember'
description: OK
summary: Gets information about the specified member in the connection.
tags:
- Member
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/members/{memberId}/set-bearing-member:
put:
operationId: SetBearingMember
parameters:
- description: ""
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: ""
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
- description: ""
explode: false
in: path
name: memberId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConMember'
description: OK
summary: Set bearing member for memberIt
tags:
- Member
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/operations:
delete:
operationId: DeleteOperations
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: Id of the connection to be modified
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
description: OK
summary: Delete all operations for the connection
tags:
- Operation
x-requiresProject: true
x-requiresConnection: true
get:
operationId: GetOperations
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the requested connection.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ConOperation'
type: array
description: OK
summary: Gets the list of operations for the connection.
tags:
- Operation
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/operations/common-properties:
get:
operationId: GetCommonOperationProperties
parameters:
- description: The unique identifier of the opened project.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConOperationCommonProperties'
description: OK
summary: Gets common operation properties.
tags:
- Operation
x-requiresProject: true
x-requiresConnection: true
put:
operationId: UpdateCommonOperationProperties
parameters:
- description: The unique identifier of the opened project.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConOperationCommonProperties'
description: "Common properties to apply (specify material IDs, or keep as\
\ null)."
responses:
"200":
description: OK
summary: Updates common properties for all operations.
tags:
- Operation
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/operations/weld-sizing:
post:
operationId: PreDesignWelds
parameters:
- description: The unique identifier of the opened project.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
- description: The weld sizing method to apply (default is FullStrength).
explode: true
in: query
name: designType
required: false
schema:
$ref: '#/components/schemas/ConWeldSizingMethodEnum'
style: form
responses:
"200":
content:
application/json:
schema:
type: string
description: OK
summary: Pre-designs welds in the connection.
tags:
- Operation
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/parameters:
delete:
operationId: DeleteParameters
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: Id of the connection where to delete parameters
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
description: OK
summary: Delete all parameters and parameter model links for the connection
connectionId in the project projectId
tags:
- Parameter
x-requiresProject: true
x-requiresConnection: true
get:
operationId: GetParameters
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection from which to retrieve parameters.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
- description: "If true, includes hidden parameters in the result."
explode: true
in: query
name: includeHidden
required: false
schema:
default: false
type: boolean
style: form
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/IdeaParameter'
type: array
description: OK
summary: Gets all parameters defined for the specified project and connection.
tags:
- Parameter
x-requiresProject: true
x-requiresConnection: true
put:
operationId: Update
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection to update.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
requestBody:
content:
application/json:
schema:
items:
$ref: '#/components/schemas/IdeaParameterUpdate'
type: array
description: New values of parameters to apply.
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ParameterUpdateResponse'
description: OK
summary: Updates parameters for the specified connection in the project with
the values provided.
tags:
- Parameter
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/evaluate-expression:
post:
operationId: EvaluateExpression
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: Id of the connection to use for evaluation expression.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
requestBody:
content:
application/json:
schema:
type: string
description: "Expression to evaluate. See the API documentation for supported\
\ syntax and examples: https://developer.ideastatica.com/docs/api/api_parameters_getting_started.html"
responses:
"200":
content:
application/json:
schema:
type: string
description: OK
summary: "Evaluate the expression and return the result.\r\nFor more details\
\ see documentation about parameters:\r\nhttps://developer.ideastatica.com/docs/api/api_parameters_getting_started.html\r\
\nor\r\nhttps://developer.ideastatica.com/docs/api/api_parameter_reference_guide.html"
tags:
- Parameter
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/presentations:
get:
operationId: GetDataScene3D
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection to be presented in Scene3D.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/DrawData'
description: OK
summary: Returns data for Scene3D visualization.
tags:
- Presentation
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/presentations/text:
get:
operationId: GetDataScene3DText
parameters:
- description: The unique identifier of the opened project.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection to be presented.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
text/plain:
schema:
type: string
application/json:
schema:
type: string
description: OK
summary: Returns serialized data for Scene3D in JSON format.
tags:
- Presentation
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/open:
post:
operationId: OpenProject
requestBody:
content:
multipart/form-data:
encoding:
ideaConFile:
style: form
schema:
$ref: '#/components/schemas/OpenProject_request'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConProject'
description: OK
summary: Opens an IdeaCon project from the provided file.
tags:
- Project
x-requiresProject: false
x-requiresConnection: false
x-extensionMethodName: OpenProject
/api/3/projects/{projectId}/close:
get:
operationId: CloseProject
parameters:
- description: The unique identifier of the project to be closed.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
type: string
description: OK
summary: Closes the project and releases resources in the service.
tags:
- Project
x-requiresProject: true
x-requiresConnection: false
/api/3/projects:
get:
operationId: GetActiveProjects
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ConProject'
type: array
description: OK
summary: Gets the list of projects in the service that were opened by the client
connected via M:IdeaStatiCa.ConnectionRestApi.Controllers.ClientController.ConnectClient.
tags:
- Project
x-requiresProject: false
x-requiresConnection: false
post:
operationId: CreateEmptyProject
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConProjectData'
description: "Optional project metadata. The DesignCode field determines\r\
\n the design code (e.g. \"ECEN\", \"American\", \"AUS\"). Defaults\
\ to ECEN if not provided."
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConProject'
description: OK
summary: Creates a new empty IdeaCon project with no connections.
tags:
- Project
x-requiresProject: false
x-requiresConnection: false
x-extensionMethodName: CreateEmptyProject
/api/3/projects/{projectId}/download:
get:
operationId: DownloadProject
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
description: OK
summary: "Downloads the current IdeaCon project from the service, including\
\ all changes made by previous API calls."
tags:
- Project
x-requiresProject: true
x-requiresConnection: false
x-extensionMethodName: SaveProject
/api/3/projects/{projectId}:
get:
operationId: GetProjectData
parameters:
- description: The unique identifier of the requested project
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConProject'
description: OK
summary: Get data of the project.
tags:
- Project
x-requiresProject: true
x-requiresConnection: false
put:
operationId: UpdateProjectData
parameters:
- description: ""
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConProjectData'
description: ""
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConProject'
description: OK
summary: Updates ConProjectData of project
tags:
- Project
x-requiresProject: true
x-requiresConnection: false
/api/3/projects/import-iom-file:
post:
operationId: ImportIOM
requestBody:
content:
multipart/form-data:
encoding:
containerXmlFile:
style: form
ConnectionsToCreate:
style: form
schema:
$ref: '#/components/schemas/ImportIOM_request'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConProject'
description: OK
summary: "Create the IDEA Connection project from IOM provided in xml format.\r\
\nThe parameter 'containerXmlFile' passed in HTTP body represents :\r\n[IdeaRS.OpenModel.OpenModelContainer](https://github.com/idea-statica/ideastatica-public/blob/main/src/IdeaRS.OpenModel/OpenModelContainer.cs)\r\
\nwhich is serialized to XML string by [IdeaRS.OpenModel.Tools.OpenModelContainerToXml](https://github.com/idea-statica/ideastatica-public/blob/main/src/IdeaRS.OpenModel/Tools.cs)"
tags:
- Project
x-requiresProject: false
x-requiresConnection: false
x-extensionMethodName: CreateProjectFromIomFile
/api/3/projects/{projectId}/update-iom-file:
post:
operationId: UpdateFromIOM
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service to be updated
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
content:
multipart/form-data:
encoding:
containerXmlFile:
style: form
schema:
$ref: '#/components/schemas/UpdateFromIOM_request'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConProject'
description: OK
summary: "Update the IDEA Connection project by [IdeaRS.OpenModel.OpenModelContainer](https://github.com/idea-statica/ideastatica-public/blob/main/src/IdeaRS.OpenModel/OpenModelContainer.cs)\
\ (model and results).\r\nIOM is passed in the body of the request as the\
\ xml string.\r\n[IdeaRS.OpenModel.Tools.OpenModelContainerToXml](https://github.com/idea-statica/ideastatica-public/blob/main/src/IdeaRS.OpenModel/Tools.cs)\
\ should be used to generate the valid xml string"
tags:
- Project
x-requiresProject: true
x-requiresConnection: false
x-extensionMethodName: UpdateProjectFromIomFile
/api/3/projects/{projectId}/reports/pdf:
post:
operationId: GeneratePdfForMutliple
parameters:
- description: The unique identifier of the opened project.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
content:
application/json:
schema:
items:
format: int32
type: integer
type: array
description: List of connection IDs to include in the report.
required: true
responses:
"200":
description: OK
summary: Generates a report for multiple connections in PDF or Word format.
tags:
- Report
x-requiresProject: true
x-requiresConnection: false
x-extensionMethodName: SaveReportPdf
/api/3/projects/{projectId}/reports/word:
post:
operationId: GenerateWordForMultiple
parameters:
- description: The unique identifier of the opened project.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
content:
application/json:
schema:
items:
format: int32
type: integer
type: array
description: List of connection IDs to include in the report.
required: true
responses:
"200":
description: OK
summary: Generates a report for multiple connections in PDF or Word format.
tags:
- Report
x-requiresProject: true
x-requiresConnection: false
x-extensionMethodName: SaveReportWord
/api/3/projects/{projectId}/connections/{connectionId}/reports/pdf:
get:
operationId: GeneratePdf
parameters:
- description: The unique identifier of the opened project.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection to report.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
description: OK
summary: "Generates a report for the specified connection in PDF, Word, or HTML\
\ zip format."
tags:
- Report
x-requiresProject: true
x-requiresConnection: true
x-extensionMethodName: SaveReportPdf
/api/3/projects/{projectId}/connections/{connectionId}/reports/word:
get:
operationId: GenerateWord
parameters:
- description: The unique identifier of the opened project.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection to report.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
description: OK
summary: "Generates a report for the specified connection in PDF, Word, or HTML\
\ zip format."
tags:
- Report
x-requiresProject: true
x-requiresConnection: true
x-extensionMethodName: SaveReportWord
/api/3/projects/{projectId}/connections/{connectionId}/reports/htmlZip:
get:
operationId: GenerateHtmlZip
parameters:
- description: The unique identifier of the opened project.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The ID of the connection to report.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
description: OK
summary: "Generates a report for the specified connection in PDF, Word, or HTML\
\ zip format."
tags:
- Report
x-requiresProject: true
x-requiresConnection: true
x-extensionMethodName: SaveReport
/api/3/projects/{projectId}/settings:
get:
operationId: GetSettings
parameters:
- description: The unique identifier of the project.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: Optional parameter to search for keywords in settings.
explode: true
in: query
name: search
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
additionalProperties: {}
type: object
description: OK
summary: Gets setting values for the project.
tags:
- Settings
x-requiresProject: true
x-requiresConnection: false
put:
operationId: UpdateSettings
parameters:
- description: The unique identifier of the project.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
content:
application/json:
schema:
additionalProperties: {}
type: object
description: Dictionary of key-value pairs representing settings to update.
responses:
"200":
content:
application/json:
schema:
additionalProperties: {}
type: object
description: OK
summary: Updates one or multiple setting values in the project.
tags:
- Settings
x-requiresProject: true
x-requiresConnection: false
/api/3/projects/{projectId}/connections/{connectionId}/templates/{templateInstanceId}:
get:
operationId: GetTemplateInConnection
parameters:
- description: The unique identifier of the project containing the connection.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The identifier of the connection.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
- description: The instance identifier of the template to retrieve.
explode: false
in: path
name: templateInstanceId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConConnectionTemplate'
description: OK
summary: Retrieves a specific template by its ID for a given connection within
a project.
tags:
- Template
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/templates:
delete:
operationId: DeleteAll
parameters:
- description: ""
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: ""
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
description: OK
summary: Delete all templates in connection
tags:
- Template
x-requiresProject: true
x-requiresConnection: true
get:
description: "This method fetches the templates applied to a connection within\
\ a project. Each template\r\n includes details such as its ID\
\ within the project, template id, members, operations, parameters, and associated\
\ common properties."
operationId: GetTemplatesInConnection
parameters:
- description: The unique identifier of the project containing the connection.
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The identifier of the connection for which templates are to be
retrieved.
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ConConnectionTemplate'
type: array
description: OK
summary: Retrieves a list of templates associated with a specific connection
within a project.
tags:
- Template
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/get-template:
get:
operationId: CreateConTemplate
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: Id of the connection to be converted to a template
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
text/plain:
schema:
type: string
description: OK
summary: Create a template for the connection connectionId in the project projectId
tags:
- Template
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/templates/create-from-connection:
post:
operationId: CreateTemplateFromConnection
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: The source of the requested template
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConTemplateCreateResult'
description: OK
summary: "Create a reusable connection template from connectionId with structured\
\ metadata.\r\nCaptures the connection's parametric design — operations, parameters,\
\ parametric links,\r\nanalysis info, loads and clipping/section data — and\
\ returns it as a contemp payload\r\nalongside metadata inherited from the\
\ source connection (design code, version,\r\nmanufacturing type, member typology,\
\ and operation/parameter/link counts)."
tags:
- Template
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/get-default-mapping:
post:
description: "The result IdeaStatiCa.Api.Connection.Model.TemplateConversionsDefault\
\ mapping to apply the passed template.\r\nIt 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."
operationId: GetDefaultTemplateMapping
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: Id of the connection to get default mapping
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConTemplateMappingGetParam'
description: Data of the template to get default mapping
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateConversions'
description: OK
summary: "Get the default mappings for the application of the connection template\
\ passed in templateToApply\r\non connectionId in the project projectId"
tags:
- Template
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/apply-template:
post:
operationId: ApplyTemplate
parameters:
- description: The unique identifier of the opened project in the ConnectionRestApi
service
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: Id of the connection where to apply the template
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConTemplateApplyParam'
description: Template to apply
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConTemplateApplyResult'
description: OK
summary: Apply the connection template applyTemplateParam on the connection
connectionId in the project projectId
tags:
- Template
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/templates/explode:
post:
operationId: ExplodeAll
parameters:
- description: ""
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: ""
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
responses:
"200":
description: OK
summary: "Explode all templates (delete parameters, keep operations)"
tags:
- Template
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/templates/{templateId}/explode:
post:
operationId: Explode
parameters:
- description: ""
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: ""
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
- description: ""
explode: false
in: path
name: templateId
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
description: OK
summary: "Explode specific template (delete parameters, keep operations)"
tags:
- Template
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/templates/{templateId}:
delete:
operationId: Delete
parameters:
- description: ""
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: ""
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
- description: ""
explode: false
in: path
name: templateId
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
description: OK
summary: Delete specific template
tags:
- Template
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/templates/{templateId}/common-properties:
get:
operationId: GetTemplateCommonOperationProperties
parameters:
- description: ""
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: ""
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
- description: ""
explode: false
in: path
name: templateId
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ConOperationCommonProperties'
description: OK
summary: Get Common properties for specific template
tags:
- Template
x-requiresProject: true
x-requiresConnection: true
put:
operationId: UpdateTemplateCommonOperationProperties
parameters:
- description: ""
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: ""
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
- description: ""
explode: false
in: path
name: templateId
required: true
schema:
format: uuid
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConOperationCommonProperties'
description: ""
responses:
"200":
description: OK
summary: Set common properties for specific template
tags:
- Template
x-requiresProject: true
x-requiresConnection: true
/api/3/projects/{projectId}/connections/{connectionId}/templates/{templateId}/load-defaults:
post:
operationId: LoadDefaults
parameters:
- description: ""
explode: false
in: path
name: projectId
required: true
schema:
format: uuid
type: string
style: simple
- description: ""
explode: false
in: path
name: connectionId
required: true
schema:
format: int32
type: integer
style: simple
- description: ""
explode: false
in: path
name: templateId
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ParameterUpdateResponse'
description: OK
summary: Load parameter defaults for specific template.
tags:
- Template
x-requiresProject: true
x-requiresConnection: true
components:
schemas:
AnchorGrid:
additionalProperties: false
example:
connectedParts:
- typeName: typeName
id: 0
element:
id: 6
- typeName: typeName
id: 0
element:
id: 6
washerSize: 9.018348186070783
concreteBlock:
lenght: 9.369310271410669
material: material
width: 6.683562403749608
height: 8.762042012749001
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
shearInThread: true
length: 2.8841621266687802
anchorInstallationProcess: postInstalled
positions:
- x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
- x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
headedStudHeadDiameter: 6.965117697638846
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
name: name
boltAssembly:
typeName: typeName
id: 0
element:
id: 6
hookLength: 3.5571952270680973
reinforcementMandrelDiameter: 1.284659006116532
id: 6
anchorType: straight
anchoringLength: 6.438423552598547
properties:
shearInThread:
type: boolean
concreteBlock:
$ref: '#/components/schemas/ConcreteBlock'
anchorType:
$ref: '#/components/schemas/AnchorType'
anchorInstallationProcess:
$ref: '#/components/schemas/InstallationProcessTypeEnum'
washerSize:
format: double
type: number
anchoringLength:
format: double
type: number
hookLength:
format: double
type: number
headedStudHeadDiameter:
format: double
type: number
reinforcementMandrelDiameter:
format: double
type: number
boltAssembly:
$ref: '#/components/schemas/ReferenceElement'
origin:
$ref: '#/components/schemas/Point3D'
axisX:
$ref: '#/components/schemas/Vector3D'
axisY:
$ref: '#/components/schemas/Vector3D'
axisZ:
$ref: '#/components/schemas/Vector3D'
positions:
items:
$ref: '#/components/schemas/Point3D'
nullable: true
type: array
connectedParts:
items:
$ref: '#/components/schemas/ReferenceElement'
nullable: true
type: array
name:
nullable: true
type: string
length:
format: double
type: number
id:
format: int32
type: integer
type: object
AnchorType:
enum:
- straight
- washerPlateCircular
- washerPlateRectangular
- hook
- headedStud
- reinforcement
- generalAnchor
type: string
BaseTemplateConversion:
additionalProperties: false
example:
newValue: newValue
newTemplateId: newTemplateId
originalValue: originalValue
description: description
originalTemplateId: originalTemplateId
properties:
originalValue:
nullable: true
type: string
originalTemplateId:
nullable: true
type: string
newValue:
nullable: true
type: string
description:
nullable: true
type: string
newTemplateId:
nullable: true
type: string
type: object
BeamData:
additionalProperties: false
example:
crossSectionType: crossSectionType
plates:
- thickness: 1.4658129805029452
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
originalModelId: originalModelId
outlinePoints:
- x: 5.962133916683182
"y": 5.637376656633329
- x: 5.962133916683182
"y": 5.637376656633329
material: material
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
isNegativeObject: true
name: name
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
geometry:
outline:
startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
openings:
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
id: 1
region: region
- thickness: 1.4658129805029452
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
originalModelId: originalModelId
outlinePoints:
- x: 5.962133916683182
"y": 5.637376656633329
- x: 5.962133916683182
"y": 5.637376656633329
material: material
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
isNegativeObject: true
name: name
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
geometry:
outline:
startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
openings:
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
id: 1
region: region
isBearingMember: true
mirrorY: true
addedMemberLength: 1.4894159098541704
autoAddCutByWorkplane: true
refLineInCenterOfGravity: true
mprlName: mprlName
originalModelId: originalModelId
isNegativeObject: true
name: name
isAdded: true
addedMember:
typeName: typeName
id: 0
element:
id: 6
id: 6
cuts:
- planePoint:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
normalVector:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
offset: 1.0246457001441578
direction: default
- planePoint:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
normalVector:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
offset: 1.0246457001441578
direction: default
properties:
name:
nullable: true
type: string
plates:
items:
$ref: '#/components/schemas/PlateData'
nullable: true
type: array
crossSectionType:
nullable: true
type: string
mprlName:
nullable: true
type: string
originalModelId:
nullable: true
type: string
cuts:
items:
$ref: '#/components/schemas/CutData'
nullable: true
type: array
isAdded:
type: boolean
addedMemberLength:
format: double
type: number
isNegativeObject:
type: boolean
addedMember:
$ref: '#/components/schemas/ReferenceElement'
mirrorY:
type: boolean
refLineInCenterOfGravity:
type: boolean
isBearingMember:
type: boolean
autoAddCutByWorkplane:
type: boolean
id:
format: int32
type: integer
type: object
BendData:
additionalProperties: false
example:
point1OfSideBoundary1:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
point1OfSideBoundary2:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
point2OfSideBoundary2:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
endFaceNormal1:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
point2OfSideBoundary1:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
plate1Id: 7
plate2Id: 1
radius: 4.965218492984954
properties:
plate1Id:
format: int32
type: integer
plate2Id:
format: int32
type: integer
radius:
format: double
type: number
point1OfSideBoundary1:
$ref: '#/components/schemas/Point3D'
point2OfSideBoundary1:
$ref: '#/components/schemas/Point3D'
endFaceNormal1:
$ref: '#/components/schemas/Vector3D'
point1OfSideBoundary2:
$ref: '#/components/schemas/Point3D'
point2OfSideBoundary2:
$ref: '#/components/schemas/Point3D'
type: object
BoltGrid:
additionalProperties: false
example:
connectedParts:
- typeName: typeName
id: 0
element:
id: 6
- typeName: typeName
id: 0
element:
id: 6
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
shearInThread: true
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
name: name
length: 5.025004791520295
boltAssembly:
typeName: typeName
id: 0
element:
id: 6
positions:
- x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
- x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
id: 9
boltInteraction: bearing
properties:
shearInThread:
type: boolean
boltInteraction:
$ref: '#/components/schemas/BoltShearType'
boltAssembly:
$ref: '#/components/schemas/ReferenceElement'
origin:
$ref: '#/components/schemas/Point3D'
axisX:
$ref: '#/components/schemas/Vector3D'
axisY:
$ref: '#/components/schemas/Vector3D'
axisZ:
$ref: '#/components/schemas/Vector3D'
positions:
items:
$ref: '#/components/schemas/Point3D'
nullable: true
type: array
connectedParts:
items:
$ref: '#/components/schemas/ReferenceElement'
nullable: true
type: array
name:
nullable: true
type: string
length:
format: double
type: number
id:
format: int32
type: integer
type: object
BoltShearType:
enum:
- bearing
- interaction
- friction
type: string
BucklingRes:
additionalProperties: false
example:
shape: 1
loadCaseId: 1
factor: 1.4894159098541704
properties:
loadCaseId:
format: int32
type: integer
shape:
format: int32
type: integer
factor:
format: double
type: number
type: object
CheckResAnchor:
additionalProperties: false
example:
unityCheck: 2.027123023002322
checkStatus: true
name: name
properties:
name:
nullable: true
type: string
unityCheck:
format: double
type: number
checkStatus:
type: boolean
type: object
CheckResBolt:
additionalProperties: false
example:
unityCheck: 3.616076749251911
checkStatus: true
name: name
properties:
name:
nullable: true
type: string
unityCheck:
format: double
type: number
checkStatus:
type: boolean
type: object
CheckResConcreteBlock:
additionalProperties: false
example:
unityCheck: 4.145608029883936
checkStatus: true
name: name
loadCaseId: 7
properties:
name:
nullable: true
type: string
unityCheck:
format: double
type: number
checkStatus:
type: boolean
loadCaseId:
format: int32
type: integer
type: object
CheckResPlate:
additionalProperties: false
example:
checkStatus: true
maxStrain: 6.027456183070403
maxStress: 1.4658129805029452
name: name
loadCaseId: 0
items:
- 5
- 5
properties:
name:
nullable: true
type: string
checkStatus:
type: boolean
loadCaseId:
format: int32
type: integer
maxStrain:
format: double
type: number
maxStress:
format: double
type: number
items:
items:
format: int32
type: integer
nullable: true
type: array
type: object
CheckResSummary:
additionalProperties: false
example:
unityCheckMessage: unityCheckMessage
checkStatus: true
name: name
checkValue: 6.027456183070403
loadCaseId: 1
skipped: true
properties:
checkValue:
format: double
type: number
checkStatus:
type: boolean
loadCaseId:
format: int32
type: integer
name:
nullable: true
type: string
unityCheckMessage:
nullable: true
type: string
skipped:
type: boolean
type: object
CheckResWeld:
additionalProperties: false
example:
unityCheck: 2.3021358869347655
checkStatus: true
name: name
id: 5
loadCaseId: 7
items:
- 9
- 9
properties:
name:
nullable: true
type: string
id:
format: int32
type: integer
unityCheck:
format: double
type: number
checkStatus:
type: boolean
loadCaseId:
format: int32
type: integer
items:
items:
format: int32
type: integer
nullable: true
type: array
type: object
ConAlignedPlate:
additionalProperties: false
example:
plateSide: default
partType: notSpecified
memberId: 9
properties:
plateSide:
$ref: '#/components/schemas/ConAlignedPlateSideCodeEnum'
memberId:
format: int32
type: integer
partType:
$ref: '#/components/schemas/ConMemberPlatePartTypeEnum'
type: object
ConAlignedPlateSideCodeEnum:
enum:
- default
- lowerSide
- upperSide
- bothSides
- center
type: string
ConAnalysisTypeEnum:
enum:
- stress_Strain
- stiffness
- capacity_Design
- fatigues
- total_Design
- horizontalTying
- capacityLoadLevels
- fireRestance
- buckling
type: string
ConConnection:
additionalProperties: false
example:
identifier: identifier
includeBuckling: true
isCalculated: true
name: name
description: description
id: 0
analysisType: stress_Strain
properties:
id:
format: int32
type: integer
identifier:
nullable: true
type: string
name:
nullable: true
type: string
description:
nullable: true
type: string
analysisType:
$ref: '#/components/schemas/ConAnalysisTypeEnum'
isCalculated:
deprecated: true
readOnly: true
type: boolean
includeBuckling:
type: boolean
type: object
ConConnectionLibrarySearchParameters:
additionalProperties: false
example:
inCompanySet: true
hasClipAngles: null
isMoment: null
members:
- 0
- 0
isParametric: null
isShear: null
inPredefinedSet: true
inPersonalSet: true
hasAnchor: null
isTruss: null
hasBolts: ignore
hasWelds: null
properties:
members:
items:
format: int32
type: integer
nullable: true
type: array
inPredefinedSet:
type: boolean
inCompanySet:
type: boolean
inPersonalSet:
type: boolean
hasBolts:
$ref: '#/components/schemas/SearchOption'
hasWelds:
$ref: '#/components/schemas/SearchOption'
hasAnchor:
$ref: '#/components/schemas/SearchOption'
hasClipAngles:
$ref: '#/components/schemas/SearchOption'
isMoment:
$ref: '#/components/schemas/SearchOption'
isShear:
$ref: '#/components/schemas/SearchOption'
isTruss:
$ref: '#/components/schemas/SearchOption'
isParametric:
$ref: '#/components/schemas/SearchOption'
type: object
ConConnectionTemplate:
additionalProperties: false
example:
commonProperties:
boltAssemblyId: 1
plateMaterialId: 6
weldMaterialId: 0
operations:
- name: name
active: true
id: 6
- name: name
active: true
id: 6
parameterKeys:
- parameterKeys
- parameterKeys
libraryTemplateId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
members:
- name: name
active: true
id: 6
- name: name
active: true
id: 6
templateId: 0
properties:
libraryTemplateId:
format: uuid
type: string
templateId:
format: int32
type: integer
members:
items:
$ref: '#/components/schemas/ConItem'
nullable: true
type: array
operations:
items:
$ref: '#/components/schemas/ConItem'
nullable: true
type: array
parameterKeys:
items:
type: string
nullable: true
type: array
commonProperties:
$ref: '#/components/schemas/ConOperationCommonProperties'
type: object
ConConversionSettings:
additionalProperties: false
example:
concrete:
- targetValue: targetValue
sourceValue: sourceValue
- targetValue: targetValue
sourceValue: sourceValue
steel:
- targetValue: targetValue
sourceValue: sourceValue
- targetValue: targetValue
sourceValue: sourceValue
welds:
- targetValue: targetValue
sourceValue: sourceValue
- targetValue: targetValue
sourceValue: sourceValue
fasteners:
- targetValue: targetValue
sourceValue: sourceValue
- targetValue: targetValue
sourceValue: sourceValue
boltGrade:
- targetValue: targetValue
sourceValue: sourceValue
- targetValue: targetValue
sourceValue: sourceValue
crossSections:
- targetValue: targetValue
sourceValue: sourceValue
- targetValue: targetValue
sourceValue: sourceValue
targetDesignCode: none
properties:
targetDesignCode:
$ref: '#/components/schemas/CountryCode'
concrete:
items:
$ref: '#/components/schemas/ConversionMapping'
nullable: true
type: array
crossSections:
items:
$ref: '#/components/schemas/ConversionMapping'
nullable: true
type: array
fasteners:
items:
$ref: '#/components/schemas/ConversionMapping'
nullable: true
type: array
steel:
items:
$ref: '#/components/schemas/ConversionMapping'
nullable: true
type: array
welds:
items:
$ref: '#/components/schemas/ConversionMapping'
nullable: true
type: array
boltGrade:
items:
$ref: '#/components/schemas/ConversionMapping'
nullable: true
type: array
type: object
ConDesignItem:
additionalProperties: false
example:
name: name
conDesignSetId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
conDesignItemId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
version: version
designCode: designCode
properties:
version:
nullable: true
type: string
name:
nullable: true
type: string
designCode:
nullable: true
type: string
conDesignSetId:
format: uuid
type: string
conDesignItemId:
format: uuid
type: string
type: object
ConDesignSet:
additionalProperties: false
example:
name: name
description: description
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
ownerId: ownerId
type: type
properties:
id:
format: uuid
type: string
name:
nullable: true
type: string
description:
nullable: true
type: string
ownerId:
nullable: true
type: string
type:
nullable: true
type: string
type: object
ConDesignSetType:
enum:
- private
- company
type: string
ConItem:
additionalProperties: false
example:
name: name
active: true
id: 6
properties:
id:
format: int32
type: integer
name:
nullable: true
type: string
active:
type: boolean
type: object
ConLoadEffect:
additionalProperties: false
example:
name: name
memberLoadings:
- sectionLoad:
vy: 1.4658129805029452
vz: 5.962133916683182
mx: 5.637376656633329
my: 2.3021358869347655
mz: 7.061401241503109
"n": 6.027456183070403
position: End
memberId: 0
- sectionLoad:
vy: 1.4658129805029452
vz: 5.962133916683182
mx: 5.637376656633329
my: 2.3021358869347655
mz: 7.061401241503109
"n": 6.027456183070403
position: End
memberId: 0
active: true
id: 9
isPercentage: true
properties:
isPercentage:
type: boolean
memberLoadings:
items:
$ref: '#/components/schemas/ConLoadEffectMemberLoad'
nullable: true
type: array
id:
format: int32
type: integer
name:
nullable: true
type: string
active:
type: boolean
type: object
ConLoadEffectMemberLoad:
additionalProperties: false
example:
sectionLoad:
vy: 1.4658129805029452
vz: 5.962133916683182
mx: 5.637376656633329
my: 2.3021358869347655
mz: 7.061401241503109
"n": 6.027456183070403
position: End
memberId: 0
properties:
memberId:
format: int32
type: integer
position:
$ref: '#/components/schemas/ConLoadEffectPositionEnum'
sectionLoad:
$ref: '#/components/schemas/ConLoadEffectSectionLoad'
type: object
ConLoadEffectPositionEnum:
enum:
- End
- Begin
type: string
ConLoadEffectSectionLoad:
additionalProperties: false
example:
vy: 1.4658129805029452
vz: 5.962133916683182
mx: 5.637376656633329
my: 2.3021358869347655
mz: 7.061401241503109
"n": 6.027456183070403
properties:
"n":
format: double
type: number
vy:
format: double
type: number
vz:
format: double
type: number
mx:
format: double
type: number
my:
format: double
type: number
mz:
format: double
type: number
type: object
ConLoadSettings:
additionalProperties: false
example:
loadsInEquilibrium: true
loadsInPercentage: true
properties:
loadsInEquilibrium:
type: boolean
loadsInPercentage:
type: boolean
type: object
ConMember:
additionalProperties: false
example:
stiffnessAnalysis:
theoreticalLengthY: 7.386281948385884
theoreticalLengthZ: 4.145608029883936
name: name
active: true
isContinuous: true
mirrorY: true
model:
x: 3.616076749251911
modelType: modelType
forcesIn: position
connectedMemberId: 2
mirrorZ: true
position:
alphaRotation: 5.962133916683182
gamaPitch: 1.4658129805029452
offsetEx: 5.637376656633329
offsetEy: 2.3021358869347655
relatedPlate:
plateSide: default
partType: notSpecified
memberId: 9
definedBy: none
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
offsetEz: 7.061401241503109
betaDirection: 6.027456183070403
alignedPlate:
plateSide: default
partType: notSpecified
memberId: 9
align: none
id: 1
crossSectionId: 0
isBearing: true
properties:
isContinuous:
type: boolean
crossSectionId:
format: int32
nullable: true
type: integer
mirrorY:
nullable: true
type: boolean
mirrorZ:
nullable: true
type: boolean
isBearing:
type: boolean
position:
$ref: '#/components/schemas/ConMemberPosition'
model:
$ref: '#/components/schemas/ConMemberModel'
stiffnessAnalysis:
$ref: '#/components/schemas/ConStiffnessAnalysis'
id:
format: int32
type: integer
name:
nullable: true
type: string
active:
type: boolean
type: object
ConMemberAlignmentTypeEnum:
enum:
- none
- toMemberPlate
- toMemberPlateRotateThenTranslate
type: string
ConMemberForcesInEnum:
enum:
- position
- node
- bolts
- selectedMemberFace
type: string
ConMemberModel:
additionalProperties: false
example:
x: 3.616076749251911
modelType: modelType
forcesIn: position
connectedMemberId: 2
properties:
modelType:
nullable: true
type: string
forcesIn:
$ref: '#/components/schemas/ConMemberForcesInEnum'
x:
format: double
nullable: true
type: number
connectedMemberId:
format: int32
nullable: true
type: integer
type: object
ConMemberPlacementDefinitionTypeEnum:
enum:
- none
- directionVector
- rotationsOfX
- lcs
type: string
ConMemberPlatePartTypeEnum:
enum:
- notSpecified
- topFlange
- bottomFlange
- bothFlanges
- web
- allCssParts
- basePlate
- endPlate
- plateWidener
- stiffener
- rib
- gussetPlate
- finPlate
- flange
- cssArcSegment
- isStub
- splice
- tonguePlate
- lidPlate
- generalPlate
- doubler
- endPlateOnFlanges
- backingPlate
- insertedPlate
- isNegative
type: string
ConMemberPosition:
additionalProperties: false
example:
alphaRotation: 5.962133916683182
gamaPitch: 1.4658129805029452
offsetEx: 5.637376656633329
offsetEy: 2.3021358869347655
relatedPlate:
plateSide: default
partType: notSpecified
memberId: 9
definedBy: none
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
offsetEz: 7.061401241503109
betaDirection: 6.027456183070403
alignedPlate:
plateSide: default
partType: notSpecified
memberId: 9
align: none
properties:
definedBy:
$ref: '#/components/schemas/ConMemberPlacementDefinitionTypeEnum'
axisX:
$ref: '#/components/schemas/Vector3D'
betaDirection:
format: double
nullable: true
type: number
gamaPitch:
format: double
nullable: true
type: number
alphaRotation:
format: double
type: number
offsetEx:
format: double
type: number
offsetEy:
format: double
type: number
offsetEz:
format: double
type: number
align:
$ref: '#/components/schemas/ConMemberAlignmentTypeEnum'
alignedPlate:
$ref: '#/components/schemas/ConAlignedPlate'
relatedPlate:
$ref: '#/components/schemas/ConAlignedPlate'
type: object
ConMprlCrossSection:
additionalProperties: false
example:
materialName: materialName
mprlName: mprlName
properties:
materialName:
nullable: true
type: string
mprlName:
nullable: true
type: string
type: object
ConMprlElement:
additionalProperties: false
example:
mprlName: mprlName
properties:
mprlName:
nullable: true
type: string
type: object
ConNonConformityIssue:
additionalProperties: false
example:
severity: info
operationId: 0
description: description
details: details
properties:
operationId:
format: int32
type: integer
description:
nullable: true
type: string
details:
nullable: true
type: string
severity:
$ref: '#/components/schemas/ConNonConformityIssueSeverity'
type: object
ConNonConformityIssueSeverity:
enum:
- info
- warning
- error
- terminatedError
type: string
ConOperation:
additionalProperties: false
example:
isImported: true
name: name
active: true
operationType: operationType
id: 0
properties:
isImported:
type: boolean
operationType:
nullable: true
type: string
id:
format: int32
type: integer
name:
nullable: true
type: string
active:
type: boolean
type: object
ConOperationCommonProperties:
additionalProperties: false
example:
boltAssemblyId: 1
plateMaterialId: 6
weldMaterialId: 0
properties:
weldMaterialId:
format: int32
nullable: true
type: integer
plateMaterialId:
format: int32
nullable: true
type: integer
boltAssemblyId:
format: int32
nullable: true
type: integer
type: object
ConProductionCost:
additionalProperties: false
example:
totalEstimatedCost: 0.8008281904610115
properties:
totalEstimatedCost:
format: double
type: number
type: object
ConProject:
additionalProperties: false
example:
projectInfo:
date: 2000-01-23T04:56:07.000+00:00
author: author
projectNumber: projectNumber
name: name
description: description
designCode: designCode
projectId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
connections:
- identifier: identifier
includeBuckling: true
isCalculated: true
name: name
description: description
id: 0
analysisType: stress_Strain
- identifier: identifier
includeBuckling: true
isCalculated: true
name: name
description: description
id: 0
analysisType: stress_Strain
properties:
projectId:
format: uuid
type: string
projectInfo:
$ref: '#/components/schemas/ConProjectData'
connections:
items:
$ref: '#/components/schemas/ConConnection'
nullable: true
type: array
type: object
ConProjectData:
additionalProperties: false
example:
date: 2000-01-23T04:56:07.000+00:00
author: author
projectNumber: projectNumber
name: name
description: description
designCode: designCode
properties:
name:
nullable: true
type: string
description:
nullable: true
type: string
projectNumber:
nullable: true
type: string
author:
nullable: true
type: string
designCode:
nullable: true
type: string
date:
format: date-time
type: string
type: object
ConResultSummary:
additionalProperties: false
example:
id: 0
passed: true
resultSummary:
- unityCheckMessage: unityCheckMessage
checkStatus: true
name: name
checkValue: 6.027456183070403
loadCaseId: 1
skipped: true
- unityCheckMessage: unityCheckMessage
checkStatus: true
name: name
checkValue: 6.027456183070403
loadCaseId: 1
skipped: true
properties:
id:
format: int32
type: integer
passed:
type: boolean
resultSummary:
items:
$ref: '#/components/schemas/CheckResSummary'
nullable: true
type: array
type: object
ConStiffnessAnalysis:
additionalProperties: false
example:
theoreticalLengthY: 7.386281948385884
theoreticalLengthZ: 4.145608029883936
properties:
theoreticalLengthZ:
format: double
nullable: true
type: number
theoreticalLengthY:
format: double
nullable: true
type: number
type: object
ConTemplateApplyParam:
additionalProperties: false
example:
mapping:
conversions:
- newValue: newValue
newTemplateId: newTemplateId
originalValue: originalValue
description: description
originalTemplateId: originalTemplateId
- newValue: newValue
newTemplateId: newTemplateId
originalValue: originalValue
description: description
originalTemplateId: originalTemplateId
countryCode: countryCode
connectionTemplate: connectionTemplate
properties:
connectionTemplate:
nullable: true
type: string
mapping:
$ref: '#/components/schemas/TemplateConversions'
type: object
ConTemplateApplyResult:
additionalProperties: false
example:
appliedWithoutIssues: true
templateModel:
commonProperties:
boltAssemblyId: 1
plateMaterialId: 6
weldMaterialId: 0
operations:
- name: name
active: true
id: 6
- name: name
active: true
id: 6
parameterKeys:
- parameterKeys
- parameterKeys
libraryTemplateId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
members:
- name: name
active: true
id: 6
- name: name
active: true
id: 6
templateId: 0
issues:
- severity: info
operationId: 0
description: description
details: details
- severity: info
operationId: 0
description: description
details: details
properties:
appliedWithoutIssues:
type: boolean
templateModel:
$ref: '#/components/schemas/ConConnectionTemplate'
issues:
items:
$ref: '#/components/schemas/ConNonConformityIssue'
nullable: true
type: array
type: object
ConTemplateCreateResult:
additionalProperties: false
example:
template: template
operationCount: 6
typologyCode: typologyCode
manufacturingType: manufacturingType
typologyCode_V2: typologyCode_V2
paramModelLinkCount: 5
parameterCount: 1
name: name
templateId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
designCode: designCode
version: 0
properties:
templateId:
format: uuid
type: string
name:
nullable: true
type: string
designCode:
nullable: true
type: string
version:
format: int32
type: integer
manufacturingType:
nullable: true
type: string
typologyCode:
nullable: true
type: string
typologyCode_V2:
nullable: true
type: string
operationCount:
format: int32
type: integer
parameterCount:
format: int32
type: integer
paramModelLinkCount:
format: int32
type: integer
template:
nullable: true
type: string
type: object
ConTemplateMappingGetParam:
additionalProperties: false
example:
template: template
memberIds:
- 0
- 0
properties:
template:
nullable: true
type: string
memberIds:
items:
format: int32
type: integer
nullable: true
type: array
type: object
ConTemplatePublishParam:
additionalProperties: false
example:
author: author
companyName: companyName
name: name
designSetType: private
properties:
name:
nullable: true
type: string
author:
nullable: true
type: string
companyName:
nullable: true
type: string
designSetType:
$ref: '#/components/schemas/ConDesignSetType'
type: object
ConWeldSizingMethodEnum:
enum:
- fullStrength
- minimumDuctility
- overStrengthFactor
- capacityEstimation
type: string
ConcreteBlock:
additionalProperties: false
example:
lenght: 9.369310271410669
material: material
width: 6.683562403749608
height: 8.762042012749001
properties:
lenght:
format: double
type: number
width:
format: double
type: number
height:
format: double
type: number
material:
nullable: true
type: string
type: object
ConcreteBlockData:
additionalProperties: false
example:
originalModelId: originalModelId
depth: 7.143538047012306
outlinePoints:
- x: 5.962133916683182
"y": 5.637376656633329
- x: 5.962133916683182
"y": 5.637376656633329
material: material
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
center:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
name: name
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
id: 3
region: region
properties:
id:
format: int32
type: integer
name:
nullable: true
type: string
depth:
format: double
type: number
material:
nullable: true
type: string
center:
$ref: '#/components/schemas/Point3D'
outlinePoints:
items:
$ref: '#/components/schemas/Point2D'
nullable: true
type: array
origin:
$ref: '#/components/schemas/Point3D'
axisX:
$ref: '#/components/schemas/Vector3D'
axisY:
$ref: '#/components/schemas/Vector3D'
axisZ:
$ref: '#/components/schemas/Vector3D'
region:
nullable: true
type: string
originalModelId:
nullable: true
type: string
type: object
ConnectionCheckRes:
additionalProperties: false
example:
checkResPlate:
- checkStatus: true
maxStrain: 6.027456183070403
maxStress: 1.4658129805029452
name: name
loadCaseId: 0
items:
- 5
- 5
- checkStatus: true
maxStrain: 6.027456183070403
maxStress: 1.4658129805029452
name: name
loadCaseId: 0
items:
- 5
- 5
checkResWeld:
- unityCheck: 2.3021358869347655
checkStatus: true
name: name
id: 5
loadCaseId: 7
items:
- 9
- 9
- unityCheck: 2.3021358869347655
checkStatus: true
name: name
id: 5
loadCaseId: 7
items:
- 9
- 9
checkResAnchor:
- unityCheck: 2.027123023002322
checkStatus: true
name: name
- unityCheck: 2.027123023002322
checkStatus: true
name: name
checkResConcreteBlock:
- unityCheck: 4.145608029883936
checkStatus: true
name: name
loadCaseId: 7
- unityCheck: 4.145608029883936
checkStatus: true
name: name
loadCaseId: 7
bucklingResults:
- shape: 1
loadCaseId: 1
factor: 1.4894159098541704
- shape: 1
loadCaseId: 1
factor: 1.4894159098541704
checkResSummary:
- unityCheckMessage: unityCheckMessage
checkStatus: true
name: name
checkValue: 6.027456183070403
loadCaseId: 1
skipped: true
- unityCheckMessage: unityCheckMessage
checkStatus: true
name: name
checkValue: 6.027456183070403
loadCaseId: 1
skipped: true
name: name
connectionID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
messages:
messages:
- number: unspecified
description: description
- number: unspecified
description: description
checkResBolt:
- unityCheck: 3.616076749251911
checkStatus: true
name: name
- unityCheck: 3.616076749251911
checkStatus: true
name: name
id: 6
properties:
checkResSummary:
items:
$ref: '#/components/schemas/CheckResSummary'
nullable: true
type: array
checkResPlate:
items:
$ref: '#/components/schemas/CheckResPlate'
nullable: true
type: array
checkResWeld:
items:
$ref: '#/components/schemas/CheckResWeld'
nullable: true
type: array
checkResBolt:
items:
$ref: '#/components/schemas/CheckResBolt'
nullable: true
type: array
checkResAnchor:
items:
$ref: '#/components/schemas/CheckResAnchor'
nullable: true
type: array
checkResConcreteBlock:
items:
$ref: '#/components/schemas/CheckResConcreteBlock'
nullable: true
type: array
bucklingResults:
items:
$ref: '#/components/schemas/BucklingRes'
nullable: true
type: array
name:
nullable: true
type: string
connectionID:
format: uuid
type: string
id:
format: int32
type: integer
messages:
$ref: '#/components/schemas/OpenMessages'
type: object
ConnectionData:
additionalProperties: false
example:
beams:
- crossSectionType: crossSectionType
plates:
- thickness: 1.4658129805029452
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
originalModelId: originalModelId
outlinePoints:
- x: 5.962133916683182
"y": 5.637376656633329
- x: 5.962133916683182
"y": 5.637376656633329
material: material
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
isNegativeObject: true
name: name
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
geometry:
outline:
startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
openings:
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
id: 1
region: region
- thickness: 1.4658129805029452
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
originalModelId: originalModelId
outlinePoints:
- x: 5.962133916683182
"y": 5.637376656633329
- x: 5.962133916683182
"y": 5.637376656633329
material: material
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
isNegativeObject: true
name: name
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
geometry:
outline:
startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
openings:
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
id: 1
region: region
isBearingMember: true
mirrorY: true
addedMemberLength: 1.4894159098541704
autoAddCutByWorkplane: true
refLineInCenterOfGravity: true
mprlName: mprlName
originalModelId: originalModelId
isNegativeObject: true
name: name
isAdded: true
addedMember:
typeName: typeName
id: 0
element:
id: 6
id: 6
cuts:
- planePoint:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
normalVector:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
offset: 1.0246457001441578
direction: default
- planePoint:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
normalVector:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
offset: 1.0246457001441578
direction: default
- crossSectionType: crossSectionType
plates:
- thickness: 1.4658129805029452
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
originalModelId: originalModelId
outlinePoints:
- x: 5.962133916683182
"y": 5.637376656633329
- x: 5.962133916683182
"y": 5.637376656633329
material: material
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
isNegativeObject: true
name: name
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
geometry:
outline:
startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
openings:
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
id: 1
region: region
- thickness: 1.4658129805029452
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
originalModelId: originalModelId
outlinePoints:
- x: 5.962133916683182
"y": 5.637376656633329
- x: 5.962133916683182
"y": 5.637376656633329
material: material
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
isNegativeObject: true
name: name
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
geometry:
outline:
startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
openings:
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
id: 1
region: region
isBearingMember: true
mirrorY: true
addedMemberLength: 1.4894159098541704
autoAddCutByWorkplane: true
refLineInCenterOfGravity: true
mprlName: mprlName
originalModelId: originalModelId
isNegativeObject: true
name: name
isAdded: true
addedMember:
typeName: typeName
id: 0
element:
id: 6
id: 6
cuts:
- planePoint:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
normalVector:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
offset: 1.0246457001441578
direction: default
- planePoint:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
normalVector:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
offset: 1.0246457001441578
direction: default
welds:
- connectedPartIds:
- connectedPartIds
- connectedPartIds
material: material
thickness: 3.353193347011243
weldType: notSpecified
name: name
start:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
end:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
id: 6
weldMaterial:
typeName: typeName
id: 0
element:
id: 6
- connectedPartIds:
- connectedPartIds
- connectedPartIds
material: material
thickness: 3.353193347011243
weldType: notSpecified
name: name
start:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
end:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
id: 6
weldMaterial:
typeName: typeName
id: 0
element:
id: 6
plates:
- thickness: 1.4658129805029452
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
originalModelId: originalModelId
outlinePoints:
- x: 5.962133916683182
"y": 5.637376656633329
- x: 5.962133916683182
"y": 5.637376656633329
material: material
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
isNegativeObject: true
name: name
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
geometry:
outline:
startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
openings:
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
id: 1
region: region
- thickness: 1.4658129805029452
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
originalModelId: originalModelId
outlinePoints:
- x: 5.962133916683182
"y": 5.637376656633329
- x: 5.962133916683182
"y": 5.637376656633329
material: material
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
isNegativeObject: true
name: name
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
geometry:
outline:
startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
openings:
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
id: 1
region: region
cutBeamByBeams:
- cuttingObject:
typeName: typeName
id: 0
element:
id: 6
orientation: null
offset: 7.058770351582356
method: boundingBox
webWeld:
thickness: 0.8851374739011653
weldType: null
weldMaterial:
typeName: typeName
id: 0
element:
id: 6
name: name
modifiedObject:
typeName: typeName
id: 0
element:
id: 6
isWeld: true
flangeWeld:
thickness: 0.8851374739011653
weldType: null
weldMaterial:
typeName: typeName
id: 0
element:
id: 6
planeOnCuttingObject: closer
cutPart: begin
extendBeforeCut: true
- cuttingObject:
typeName: typeName
id: 0
element:
id: 6
orientation: null
offset: 7.058770351582356
method: boundingBox
webWeld:
thickness: 0.8851374739011653
weldType: null
weldMaterial:
typeName: typeName
id: 0
element:
id: 6
name: name
modifiedObject:
typeName: typeName
id: 0
element:
id: 6
isWeld: true
flangeWeld:
thickness: 0.8851374739011653
weldType: null
weldMaterial:
typeName: typeName
id: 0
element:
id: 6
planeOnCuttingObject: closer
cutPart: begin
extendBeforeCut: true
anchorGrids:
- connectedParts:
- typeName: typeName
id: 0
element:
id: 6
- typeName: typeName
id: 0
element:
id: 6
washerSize: 9.018348186070783
concreteBlock:
lenght: 9.369310271410669
material: material
width: 6.683562403749608
height: 8.762042012749001
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
shearInThread: true
length: 2.8841621266687802
anchorInstallationProcess: postInstalled
positions:
- x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
- x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
headedStudHeadDiameter: 6.965117697638846
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
name: name
boltAssembly:
typeName: typeName
id: 0
element:
id: 6
hookLength: 3.5571952270680973
reinforcementMandrelDiameter: 1.284659006116532
id: 6
anchorType: straight
anchoringLength: 6.438423552598547
- connectedParts:
- typeName: typeName
id: 0
element:
id: 6
- typeName: typeName
id: 0
element:
id: 6
washerSize: 9.018348186070783
concreteBlock:
lenght: 9.369310271410669
material: material
width: 6.683562403749608
height: 8.762042012749001
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
shearInThread: true
length: 2.8841621266687802
anchorInstallationProcess: postInstalled
positions:
- x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
- x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
headedStudHeadDiameter: 6.965117697638846
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
name: name
boltAssembly:
typeName: typeName
id: 0
element:
id: 6
hookLength: 3.5571952270680973
reinforcementMandrelDiameter: 1.284659006116532
id: 6
anchorType: straight
anchoringLength: 6.438423552598547
concreteBlocks:
- originalModelId: originalModelId
depth: 7.143538047012306
outlinePoints:
- x: 5.962133916683182
"y": 5.637376656633329
- x: 5.962133916683182
"y": 5.637376656633329
material: material
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
center:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
name: name
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
id: 3
region: region
- originalModelId: originalModelId
depth: 7.143538047012306
outlinePoints:
- x: 5.962133916683182
"y": 5.637376656633329
- x: 5.962133916683182
"y": 5.637376656633329
material: material
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
center:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
name: name
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
id: 3
region: region
connectionPoint:
typeName: typeName
id: 0
element:
id: 6
foldedPlates:
- plates:
- thickness: 1.4658129805029452
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
originalModelId: originalModelId
outlinePoints:
- x: 5.962133916683182
"y": 5.637376656633329
- x: 5.962133916683182
"y": 5.637376656633329
material: material
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
isNegativeObject: true
name: name
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
geometry:
outline:
startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
openings:
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
id: 1
region: region
- thickness: 1.4658129805029452
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
originalModelId: originalModelId
outlinePoints:
- x: 5.962133916683182
"y": 5.637376656633329
- x: 5.962133916683182
"y": 5.637376656633329
material: material
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
isNegativeObject: true
name: name
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
geometry:
outline:
startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
openings:
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
id: 1
region: region
bends:
- point1OfSideBoundary1:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
point1OfSideBoundary2:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
point2OfSideBoundary2:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
endFaceNormal1:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
point2OfSideBoundary1:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
plate1Id: 7
plate2Id: 1
radius: 4.965218492984954
- point1OfSideBoundary1:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
point1OfSideBoundary2:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
point2OfSideBoundary2:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
endFaceNormal1:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
point2OfSideBoundary1:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
plate1Id: 7
plate2Id: 1
radius: 4.965218492984954
- plates:
- thickness: 1.4658129805029452
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
originalModelId: originalModelId
outlinePoints:
- x: 5.962133916683182
"y": 5.637376656633329
- x: 5.962133916683182
"y": 5.637376656633329
material: material
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
isNegativeObject: true
name: name
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
geometry:
outline:
startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
openings:
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
id: 1
region: region
- thickness: 1.4658129805029452
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
originalModelId: originalModelId
outlinePoints:
- x: 5.962133916683182
"y": 5.637376656633329
- x: 5.962133916683182
"y": 5.637376656633329
material: material
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
isNegativeObject: true
name: name
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
geometry:
outline:
startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
openings:
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
id: 1
region: region
bends:
- point1OfSideBoundary1:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
point1OfSideBoundary2:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
point2OfSideBoundary2:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
endFaceNormal1:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
point2OfSideBoundary1:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
plate1Id: 7
plate2Id: 1
radius: 4.965218492984954
- point1OfSideBoundary1:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
point1OfSideBoundary2:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
point2OfSideBoundary2:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
endFaceNormal1:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
point2OfSideBoundary1:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
plate1Id: 7
plate2Id: 1
radius: 4.965218492984954
pinGrids:
- connectedParts:
- typeName: typeName
id: 0
element:
id: 6
- typeName: typeName
id: 0
element:
id: 6
pin:
typeName: typeName
id: 0
element:
id: 6
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
name: name
length: 6.878052220127876
isReplaceable: true
positions:
- x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
- x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
id: 5
- connectedParts:
- typeName: typeName
id: 0
element:
id: 6
- typeName: typeName
id: 0
element:
id: 6
pin:
typeName: typeName
id: 0
element:
id: 6
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
name: name
length: 6.878052220127876
isReplaceable: true
positions:
- x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
- x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
id: 5
boltGrids:
- connectedParts:
- typeName: typeName
id: 0
element:
id: 6
- typeName: typeName
id: 0
element:
id: 6
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
shearInThread: true
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
name: name
length: 5.025004791520295
boltAssembly:
typeName: typeName
id: 0
element:
id: 6
positions:
- x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
- x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
id: 9
boltInteraction: bearing
- connectedParts:
- typeName: typeName
id: 0
element:
id: 6
- typeName: typeName
id: 0
element:
id: 6
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
shearInThread: true
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
name: name
length: 5.025004791520295
boltAssembly:
typeName: typeName
id: 0
element:
id: 6
positions:
- x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
- x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
id: 9
boltInteraction: bearing
properties:
connectionPoint:
$ref: '#/components/schemas/ReferenceElement'
beams:
items:
$ref: '#/components/schemas/BeamData'
nullable: true
type: array
plates:
items:
$ref: '#/components/schemas/PlateData'
nullable: true
type: array
foldedPlates:
items:
$ref: '#/components/schemas/FoldedPlateData'
nullable: true
type: array
boltGrids:
items:
$ref: '#/components/schemas/BoltGrid'
nullable: true
type: array
anchorGrids:
items:
$ref: '#/components/schemas/AnchorGrid'
nullable: true
type: array
pinGrids:
items:
$ref: '#/components/schemas/PinGrid'
nullable: true
type: array
welds:
items:
$ref: '#/components/schemas/WeldData'
nullable: true
type: array
concreteBlocks:
items:
$ref: '#/components/schemas/ConcreteBlockData'
nullable: true
type: array
cutBeamByBeams:
items:
$ref: '#/components/schemas/CutBeamByBeamData'
nullable: true
type: array
type: object
ConversionMapping:
additionalProperties: false
example:
targetValue: targetValue
sourceValue: sourceValue
properties:
sourceValue:
nullable: true
type: string
targetValue:
nullable: true
type: string
type: object
CountryCode:
enum:
- none
- ecen
- india
- sia
- american
- canada
- australia
- rus
- chn
- hkg
type: string
CutBeamByBeamData:
additionalProperties: false
example:
cuttingObject:
typeName: typeName
id: 0
element:
id: 6
orientation: null
offset: 7.058770351582356
method: boundingBox
webWeld:
thickness: 0.8851374739011653
weldType: null
weldMaterial:
typeName: typeName
id: 0
element:
id: 6
name: name
modifiedObject:
typeName: typeName
id: 0
element:
id: 6
isWeld: true
flangeWeld:
thickness: 0.8851374739011653
weldType: null
weldMaterial:
typeName: typeName
id: 0
element:
id: 6
planeOnCuttingObject: closer
cutPart: begin
extendBeforeCut: true
properties:
name:
nullable: true
type: string
modifiedObject:
$ref: '#/components/schemas/ReferenceElement'
cuttingObject:
$ref: '#/components/schemas/ReferenceElement'
isWeld:
type: boolean
webWeld:
$ref: '#/components/schemas/WeldDefinition'
flangeWeld:
$ref: '#/components/schemas/WeldDefinition'
offset:
format: double
type: number
method:
$ref: '#/components/schemas/CutMethod'
orientation:
$ref: '#/components/schemas/CutOrientation'
planeOnCuttingObject:
$ref: '#/components/schemas/DistanceComparison'
cutPart:
$ref: '#/components/schemas/CutPart'
extendBeforeCut:
type: boolean
type: object
CutData:
additionalProperties: false
example:
planePoint:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
normalVector:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
offset: 1.0246457001441578
direction: default
properties:
planePoint:
$ref: '#/components/schemas/Point3D'
normalVector:
$ref: '#/components/schemas/Vector3D'
direction:
$ref: '#/components/schemas/CutOrientation'
offset:
format: double
type: number
type: object
CutMethod:
enum:
- boundingBox
- surface
- mitre
- surfaceAll
type: string
CutOrientation:
enum:
- default
- parallel
- perpendicular
type: string
CutPart:
enum:
- begin
- end
type: string
DistanceComparison:
enum:
- closer
- farther
- same
type: string
DrawData:
additionalProperties: false
example:
vertices:
- 4.145608029883936
- 4.145608029883936
groups:
- text:
- color:
- 2
- 2
fontSize: 3.616076749251911
position:
angles:
- 9.301444243932576
- 9.301444243932576
origin:
- 7.061401241503109
- 7.061401241503109
tag: 2.027123023002322
value: value
- color:
- 2
- 2
fontSize: 3.616076749251911
position:
angles:
- 9.301444243932576
- 9.301444243932576
origin:
- 7.061401241503109
- 7.061401241503109
tag: 2.027123023002322
value: value
faces:
- 0
- 0
lines:
- color:
- 6
- 6
thickness: 5.962133916683182
pairs:
- 1
- 1
- color:
- 6
- 6
thickness: 5.962133916683182
pairs:
- 1
- 1
priority: 5
selected:
id: id
type:
kind: kind
- text:
- color:
- 2
- 2
fontSize: 3.616076749251911
position:
angles:
- 9.301444243932576
- 9.301444243932576
origin:
- 7.061401241503109
- 7.061401241503109
tag: 2.027123023002322
value: value
- color:
- 2
- 2
fontSize: 3.616076749251911
position:
angles:
- 9.301444243932576
- 9.301444243932576
origin:
- 7.061401241503109
- 7.061401241503109
tag: 2.027123023002322
value: value
faces:
- 0
- 0
lines:
- color:
- 6
- 6
thickness: 5.962133916683182
pairs:
- 1
- 1
- color:
- 6
- 6
thickness: 5.962133916683182
pairs:
- 1
- 1
priority: 5
selected:
id: id
type:
kind: kind
normals:
- 7.386281948385884
- 7.386281948385884
properties:
groups:
items:
$ref: '#/components/schemas/IGroup'
nullable: true
type: array
vertices:
items:
format: double
type: number
nullable: true
type: array
normals:
items:
format: double
type: number
nullable: true
type: array
type: object
FoldedPlateData:
additionalProperties: false
example:
plates:
- thickness: 1.4658129805029452
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
originalModelId: originalModelId
outlinePoints:
- x: 5.962133916683182
"y": 5.637376656633329
- x: 5.962133916683182
"y": 5.637376656633329
material: material
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
isNegativeObject: true
name: name
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
geometry:
outline:
startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
openings:
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
id: 1
region: region
- thickness: 1.4658129805029452
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
originalModelId: originalModelId
outlinePoints:
- x: 5.962133916683182
"y": 5.637376656633329
- x: 5.962133916683182
"y": 5.637376656633329
material: material
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
isNegativeObject: true
name: name
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
geometry:
outline:
startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
openings:
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
id: 1
region: region
bends:
- point1OfSideBoundary1:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
point1OfSideBoundary2:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
point2OfSideBoundary2:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
endFaceNormal1:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
point2OfSideBoundary1:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
plate1Id: 7
plate2Id: 1
radius: 4.965218492984954
- point1OfSideBoundary1:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
point1OfSideBoundary2:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
point2OfSideBoundary2:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
endFaceNormal1:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
point2OfSideBoundary1:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
plate1Id: 7
plate2Id: 1
radius: 4.965218492984954
properties:
plates:
items:
$ref: '#/components/schemas/PlateData'
nullable: true
type: array
bends:
items:
$ref: '#/components/schemas/BendData'
nullable: true
type: array
type: object
IGroup:
additionalProperties: false
example:
text:
- color:
- 2
- 2
fontSize: 3.616076749251911
position:
angles:
- 9.301444243932576
- 9.301444243932576
origin:
- 7.061401241503109
- 7.061401241503109
tag: 2.027123023002322
value: value
- color:
- 2
- 2
fontSize: 3.616076749251911
position:
angles:
- 9.301444243932576
- 9.301444243932576
origin:
- 7.061401241503109
- 7.061401241503109
tag: 2.027123023002322
value: value
faces:
- 0
- 0
lines:
- color:
- 6
- 6
thickness: 5.962133916683182
pairs:
- 1
- 1
- color:
- 6
- 6
thickness: 5.962133916683182
pairs:
- 1
- 1
priority: 5
selected:
id: id
type:
kind: kind
properties:
faces:
items:
format: int32
type: integer
nullable: true
type: array
selected:
$ref: '#/components/schemas/Selected'
lines:
items:
$ref: '#/components/schemas/Line'
nullable: true
type: array
priority:
format: int32
type: integer
text:
items:
$ref: '#/components/schemas/Text'
nullable: true
type: array
type: object
IdeaParameter:
additionalProperties: false
example:
parameterType: parameterType
default: default
unit: unit
expression: expression
upperBound: upperBound
description: description
lowerBound: lowerBound
isVisible: true
parameterValidation:
validationExpression: validationExpression
upperBound: upperBound
upperBoundEvaluated: 6.027456183070403
validationExpressionEvaluated: true
lowerBound: lowerBound
message: message
validationStatus: validationStatus
lowerBoundEvaluated: 0.8008281904610115
value: ""
validationStatus: validationStatus
key: key
properties:
key:
nullable: true
type: string
expression:
nullable: true
type: string
default:
nullable: true
type: string
value:
nullable: true
unit:
nullable: true
type: string
parameterType:
nullable: true
type: string
description:
nullable: true
type: string
validationStatus:
nullable: true
type: string
isVisible:
nullable: true
type: boolean
lowerBound:
nullable: true
type: string
upperBound:
nullable: true
type: string
parameterValidation:
$ref: '#/components/schemas/IdeaParameterValidation'
type: object
IdeaParameterUpdate:
additionalProperties: false
example:
expression: expression
key: key
properties:
key:
nullable: true
type: string
expression:
nullable: true
type: string
type: object
IdeaParameterValidation:
additionalProperties: false
example:
validationExpression: validationExpression
upperBound: upperBound
upperBoundEvaluated: 6.027456183070403
validationExpressionEvaluated: true
lowerBound: lowerBound
message: message
validationStatus: validationStatus
lowerBoundEvaluated: 0.8008281904610115
properties:
validationExpression:
nullable: true
type: string
validationExpressionEvaluated:
type: boolean
lowerBound:
nullable: true
type: string
lowerBoundEvaluated:
format: double
type: number
upperBound:
nullable: true
type: string
upperBoundEvaluated:
format: double
type: number
validationStatus:
nullable: true
type: string
message:
nullable: true
type: string
type: object
IdeaParameterValidationResponse:
additionalProperties: false
example:
message: message
validationStatus: validationStatus
key: key
properties:
key:
nullable: true
type: string
message:
nullable: true
type: string
validationStatus:
nullable: true
type: string
type: object
InstallationProcessTypeEnum:
enum:
- postInstalled
- castInPlace
type: string
Line:
additionalProperties: false
example:
color:
- 6
- 6
thickness: 5.962133916683182
pairs:
- 1
- 1
properties:
color:
items:
format: int32
type: integer
nullable: true
type: array
pairs:
items:
format: int32
type: integer
nullable: true
type: array
thickness:
format: double
type: number
type: object
MessageNumber:
enum:
- unspecified
- information
- warning
- warnNoPropertyInData
- warnValueOutOfRange
- warnCurveCount
- warnReinforcementBarsCollision
- error
- errNoOpenObject
- errDataObjectNotCreated
- errNoObjectInOpenModel
- errNoReferenceObjectInOpenModel
- errNoEquivalentObjectInDataModel
- errNoCrossSectionParameter
- errBoltsTooClose
- errBoltsTooCloseEdge
- errContactsAngle
- errIncorrentMaterialE
- errIncorrectMaterialEGP
- errPreloadedBoltGrade
- errValueOutOfRange
- errCurveZeroPoint
- errCurveFunction
- errCurveDecreaseFunction
- errCurveDerivation
- errCurveNotSet
- errValidPolyline
- errWarningLoad
- errTimeout
- errNoInLibrary
- errBadWeldMaterialProperty
- errOperation
- reserved
type: string
OpenElementId:
additionalProperties: false
example:
id: 6
properties:
id:
format: int32
type: integer
type: object
OpenMessage:
additionalProperties: false
example:
number: unspecified
description: description
properties:
number:
$ref: '#/components/schemas/MessageNumber'
description:
nullable: true
type: string
type: object
OpenMessages:
additionalProperties: false
example:
messages:
- number: unspecified
description: description
- number: unspecified
description: description
properties:
messages:
items:
$ref: '#/components/schemas/OpenMessage'
nullable: true
type: array
type: object
ParameterUpdateResponse:
additionalProperties: false
example:
setToModel: true
failedValidations:
- message: message
validationStatus: validationStatus
key: key
- message: message
validationStatus: validationStatus
key: key
parameters:
- parameterType: parameterType
default: default
unit: unit
expression: expression
upperBound: upperBound
description: description
lowerBound: lowerBound
isVisible: true
parameterValidation:
validationExpression: validationExpression
upperBound: upperBound
upperBoundEvaluated: 6.027456183070403
validationExpressionEvaluated: true
lowerBound: lowerBound
message: message
validationStatus: validationStatus
lowerBoundEvaluated: 0.8008281904610115
value: ""
validationStatus: validationStatus
key: key
- parameterType: parameterType
default: default
unit: unit
expression: expression
upperBound: upperBound
description: description
lowerBound: lowerBound
isVisible: true
parameterValidation:
validationExpression: validationExpression
upperBound: upperBound
upperBoundEvaluated: 6.027456183070403
validationExpressionEvaluated: true
lowerBound: lowerBound
message: message
validationStatus: validationStatus
lowerBoundEvaluated: 0.8008281904610115
value: ""
validationStatus: validationStatus
key: key
properties:
setToModel:
type: boolean
parameters:
items:
$ref: '#/components/schemas/IdeaParameter'
nullable: true
type: array
failedValidations:
items:
$ref: '#/components/schemas/IdeaParameterValidationResponse'
nullable: true
type: array
type: object
PinGrid:
additionalProperties: false
example:
connectedParts:
- typeName: typeName
id: 0
element:
id: 6
- typeName: typeName
id: 0
element:
id: 6
pin:
typeName: typeName
id: 0
element:
id: 6
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
name: name
length: 6.878052220127876
isReplaceable: true
positions:
- x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
- x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
id: 5
properties:
isReplaceable:
type: boolean
pin:
$ref: '#/components/schemas/ReferenceElement'
origin:
$ref: '#/components/schemas/Point3D'
axisX:
$ref: '#/components/schemas/Vector3D'
axisY:
$ref: '#/components/schemas/Vector3D'
axisZ:
$ref: '#/components/schemas/Vector3D'
positions:
items:
$ref: '#/components/schemas/Point3D'
nullable: true
type: array
connectedParts:
items:
$ref: '#/components/schemas/ReferenceElement'
nullable: true
type: array
name:
nullable: true
type: string
length:
format: double
type: number
id:
format: int32
type: integer
type: object
PlateData:
additionalProperties: false
example:
thickness: 1.4658129805029452
origin:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
originalModelId: originalModelId
outlinePoints:
- x: 5.962133916683182
"y": 5.637376656633329
- x: 5.962133916683182
"y": 5.637376656633329
material: material
axisZ:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
axisY:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
isNegativeObject: true
name: name
axisX:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
geometry:
outline:
startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
openings:
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
id: 1
region: region
properties:
name:
nullable: true
type: string
thickness:
format: double
type: number
material:
nullable: true
type: string
outlinePoints:
items:
$ref: '#/components/schemas/Point2D'
nullable: true
type: array
origin:
$ref: '#/components/schemas/Point3D'
axisX:
$ref: '#/components/schemas/Vector3D'
axisY:
$ref: '#/components/schemas/Vector3D'
axisZ:
$ref: '#/components/schemas/Vector3D'
region:
nullable: true
type: string
geometry:
$ref: '#/components/schemas/Region2D'
originalModelId:
nullable: true
type: string
isNegativeObject:
type: boolean
id:
format: int32
type: integer
type: object
Point2D:
additionalProperties: false
example:
x: 5.962133916683182
"y": 5.637376656633329
properties:
x:
format: double
type: number
"y":
format: double
type: number
type: object
Point3D:
additionalProperties: false
example:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
properties:
x:
format: double
type: number
"y":
format: double
type: number
z:
format: double
type: number
id:
format: int32
type: integer
type: object
PolyLine2D:
additionalProperties: false
example:
startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
properties:
startPoint:
$ref: '#/components/schemas/Point2D'
segments:
items:
$ref: '#/components/schemas/Segment2D'
nullable: true
type: array
type: object
ReferenceElement:
additionalProperties: false
example:
typeName: typeName
id: 0
element:
id: 6
properties:
typeName:
nullable: true
type: string
id:
format: int32
type: integer
element:
$ref: '#/components/schemas/OpenElementId'
type: object
Region2D:
additionalProperties: false
example:
outline:
startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
openings:
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- startPoint:
x: 5.962133916683182
"y": 5.637376656633329
segments:
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
- endPoint:
x: 5.962133916683182
"y": 5.637376656633329
properties:
outline:
$ref: '#/components/schemas/PolyLine2D'
openings:
items:
$ref: '#/components/schemas/PolyLine2D'
nullable: true
type: array
type: object
SearchOption:
enum:
- ignore
- must
- mustNot
type: string
Segment2D:
additionalProperties: false
example:
endPoint:
x: 5.962133916683182
"y": 5.637376656633329
properties:
endPoint:
$ref: '#/components/schemas/Point2D'
type: object
Selected:
additionalProperties: false
example:
id: id
type:
kind: kind
properties:
id:
nullable: true
type: string
type:
$ref: '#/components/schemas/SelectedType'
type: object
SelectedType:
additionalProperties: false
example:
kind: kind
properties:
kind:
nullable: true
readOnly: true
type: string
type: object
TemplateConversions:
additionalProperties: false
example:
conversions:
- newValue: newValue
newTemplateId: newTemplateId
originalValue: originalValue
description: description
originalTemplateId: originalTemplateId
- newValue: newValue
newTemplateId: newTemplateId
originalValue: originalValue
description: description
originalTemplateId: originalTemplateId
countryCode: countryCode
properties:
conversions:
items:
$ref: '#/components/schemas/BaseTemplateConversion'
nullable: true
type: array
countryCode:
nullable: true
type: string
type: object
Text:
additionalProperties: false
example:
color:
- 2
- 2
fontSize: 3.616076749251911
position:
angles:
- 9.301444243932576
- 9.301444243932576
origin:
- 7.061401241503109
- 7.061401241503109
tag: 2.027123023002322
value: value
properties:
color:
items:
format: int32
type: integer
nullable: true
type: array
value:
nullable: true
type: string
position:
$ref: '#/components/schemas/TextPosition'
fontSize:
format: double
type: number
tag:
format: double
type: number
type: object
TextPosition:
additionalProperties: false
example:
angles:
- 9.301444243932576
- 9.301444243932576
origin:
- 7.061401241503109
- 7.061401241503109
properties:
origin:
items:
format: double
type: number
nullable: true
type: array
angles:
items:
format: double
type: number
nullable: true
type: array
type: object
Vector3D:
additionalProperties: false
example:
x: 2.027123023002322
"y": 4.145608029883936
z: 7.386281948385884
properties:
x:
format: double
type: number
"y":
format: double
type: number
z:
format: double
type: number
type: object
WeldData:
additionalProperties: false
example:
connectedPartIds:
- connectedPartIds
- connectedPartIds
material: material
thickness: 3.353193347011243
weldType: notSpecified
name: name
start:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
end:
x: 2.3021358869347655
"y": 7.061401241503109
z: 9.301444243932576
id: 3
id: 6
weldMaterial:
typeName: typeName
id: 0
element:
id: 6
properties:
id:
format: int32
type: integer
name:
nullable: true
type: string
thickness:
format: double
type: number
material:
nullable: true
type: string
weldMaterial:
$ref: '#/components/schemas/ReferenceElement'
weldType:
$ref: '#/components/schemas/WeldType'
connectedPartIds:
items:
type: string
nullable: true
type: array
start:
$ref: '#/components/schemas/Point3D'
end:
$ref: '#/components/schemas/Point3D'
type: object
WeldDefinition:
additionalProperties: false
example:
thickness: 0.8851374739011653
weldType: null
weldMaterial:
typeName: typeName
id: 0
element:
id: 6
properties:
thickness:
format: double
type: number
weldType:
$ref: '#/components/schemas/WeldType'
weldMaterial:
$ref: '#/components/schemas/ReferenceElement'
type: object
WeldType:
enum:
- notSpecified
- fillet
- doubleFillet
- bevel
- pjp
- pjpRear
- lengthAtHaunch
- filletRear
- contact
- intermittent
type: string
OpenProject_request:
properties:
ideaConFile:
description: The IdeaCon file to open.
format: binary
type: string
type: object
ImportIOM_request:
properties:
containerXmlFile:
description: IdeaRS.OpenModel.OpenModelContainer serialized to xml
format: binary
type: string
ConnectionsToCreate:
items:
format: int32
type: integer
type: array
type: object
UpdateFromIOM_request:
properties:
containerXmlFile:
description: IdeaRS.OpenModel.OpenModelContainer serialized to xml
format: binary
type: string
type: object