---
title: "List CAD topology with entity attributes"
method: GET
path: "/cads/{cadId}/states/{cadStateId}/topology"
tags: ["CADs"]
---

# List CAD topology with entity attributes

`GET /cads/{cadId}/states/{cadStateId}/topology`

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.

## Response `200`

Successful operation

- CadTopology
  - `_links` CollectionLinks
    - `first` object
      - `href` string — First page of the collection.
    - `prev` object
      - `href` string — Previous page in the collection.
    - `self` object
      - `href` string — Current page of the collection.
    - `next` object
      - `href` string — Next page in the collection.
    - `last` object
      - `href` string — Last page of the collection.
  - `_meta` CollectionMeta
    - `total` integer — Total number of resources in the collection.
  - `_embedded` EntityDescription[]
    - `name` string — The internal name of the entity.
    - `class` string — The topological entity class (body or face).
    - `originateFrom` OriginalEntityReference[]
      - `path` BodyPath[] — The path from the root of the model.
        - `assembly` string
        - `instance` string
      - `body` string — The original body name.
      - `entity` string — The original entity name.
      - `attributeList` EntityAttribute[] — The attributes assigned to the entity.
        - `attribute` string
        - `value` string

## Other responses

- `400` — Bad request.
- `403` — Insufficient Permissions
- `404` — Not found.

---

[API](https://skmtc.net/simscale/apis/simscale-api.md) · [All operations](https://skmtc.net/simscale/apis/simscale-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/simscale/simscale-api/revisions/53223abaceb7/schema)