Sign in
latestOpenAPI 3.0.32026-08-201592,4923.4 MB

53223abaceb7

CADs

List CAD topology with entity attributes

Assignment of topological entities (e.g. faces, bodies) in the simulation setup is a non-trivial task. Complex models can consist of several assemblies which may contain multiple occurrences of bodies and their entities. In order to identify an assignment unambiguously, the full path from the root part of the model to the actual topological entity is required.

SimScale generates unique internal names for all topological entities of a model during the CAD import which are used for assignments within the simulation spec. Examples of internal names are B1_TE5 or A1_I26_A5_I27_B102_TE196.

This API endpoint lists the CAD model’s topology with all relevant attributes for each entity, such as:

  • The topological entity class (body or face)
  • The original body and entity names
  • Entity attributes like SDL/TYSA_NAME, SDL/TYSA_UNAME, ATTRIB_XPARASOLID_NAME or SDL/TYSA_COLOUR
  • The path from the root of the model

Please note that during the CAD import the model's topology can be modified (e.g. when the facet split option is enabled). This means that there might not be a 1:1 mapping between the internal and original names.

get/cads/{cadId}/states/{cadStateId}/topology

Response

Successful operation

Example response

{
  "_links": {
    "first": {
      "href": "/projects?page={firstPage}&limit={limit}"
    },
    "prev": {
      "href": "/projects?page={previousPage}&limit={limit}"
    },
    "self": {
      "href": "/projects?page={currentPage}&limit={limit}"
    },
    "next": {
      "href": "/projects?page={nextPage}&limit={limit}"
    },
    "last": {
      "href": "/projects?page={lastPage}&limit={limit}"
    }
  },
  "_embedded": [
    {
      "name": "B1_TE1",
      "class": "body",
      "originateFrom": [
        {
          "path": [],
          "body": "CentralPark",
          "entity": "Tower",
          "attributeList": []
        }
      ]
    }
  ]
}