> For the complete documentation index, see [llms.txt](https://docs.truedat.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.truedat.io/v8.8/api-integrations/data-catalog-data-lineage-and-grants-apis/data-structure-types.md).

# Data Structure Types

## Get data structure type

> Retrieves details for the specified data structure type.

```json
{"openapi":"3.0.0","info":{"title":"td-dd","version":"Truedat 8.8.2"},"paths":{"/api/data_structure_types/{id}":{"get":{"description":"Retrieves details for the specified data structure type.","operationId":"TdDdWeb.DataStructureTypeController.show","parameters":[{"description":"Data structure type ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataStructureTypeResponse"}}},"description":"Data structure type details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdUnauthorizedResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdForbiddenResponse"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdInternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Get data structure type","tags":["Data Structure Types"]}}},"components":{"schemas":{"DataStructureTypeResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/DataStructureType"}},"required":["data"],"title":"DataStructureTypeResponse","type":"object"},"DataStructureType":{"additionalProperties":false,"properties":{"filters":{"items":{"type":"string"},"nullable":true,"type":"array"},"id":{"type":"integer"},"metadata_fields":{"items":{"type":"object"},"nullable":true,"type":"array"},"metadata_views":{"items":{"type":"object"},"nullable":true,"type":"array"},"name":{"type":"string"},"template":{"nullable":true,"properties":{"content":{"items":{"type":"object"},"nullable":true,"type":"array"},"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"template_id":{"nullable":true,"type":"integer"},"translation":{"nullable":true,"type":"string"}},"required":["id","name"],"title":"DataStructureType","type":"object"},"TdDdUnauthorizedResponse":{"anyOf":[{"$ref":"#/components/schemas/TdDdUnauthorizedMessageResponse"},{"$ref":"#/components/schemas/TdDdUnauthorizedErrorResponse"}],"description":"Unauthorized response from auth plug or error view","title":"TdDdUnauthorizedResponse"},"TdDdUnauthorizedMessageResponse":{"additionalProperties":false,"properties":{"message":{"type":"string"}},"required":["message"],"title":"TdDdUnauthorizedMessageResponse","type":"object"},"TdDdUnauthorizedErrorResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"required":["errors"],"title":"TdDdUnauthorizedErrorResponse","type":"object"},"TdDdForbiddenResponse":{"additionalProperties":false,"properties":{"errors":{"additionalProperties":false,"properties":{"detail":{"type":"string"}},"required":["detail"],"type":"object"}},"required":["errors"],"title":"TdDdForbiddenResponse","type":"object"},"TdDdInternalServerErrorResponse":{"additionalProperties":false,"properties":{"errors":{"additionalProperties":false,"properties":{"detail":{"type":"string"}},"required":["detail"],"type":"object"}},"required":["errors"],"title":"TdDdInternalServerErrorResponse","type":"object"}}}}
```

## Update data structure type

> Updates the specified data structure type with the provided payload.

```json
{"openapi":"3.0.0","info":{"title":"td-dd","version":"Truedat 8.8.2"},"paths":{"/api/data_structure_types/{id}":{"put":{"description":"Updates the specified data structure type with the provided payload.","operationId":"TdDdWeb.DataStructureTypeController.update","parameters":[{"description":"Data structure type ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataStructureTypeUpdateRequest"}}},"description":"Data structure type payload","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataStructureTypeResponse"}}},"description":"Data structure type updated"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdUnauthorizedResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdForbiddenResponse"}}},"description":"Forbidden"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdUnprocessableEntityObjectResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdInternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Update data structure type","tags":["Data Structure Types"]}}},"components":{"schemas":{"DataStructureTypeUpdateRequest":{"additionalProperties":false,"properties":{"data_structure_type":{"additionalProperties":false,"properties":{"filters":{"items":{"type":"string"},"type":"array"},"metadata_views":{"items":{"type":"object"},"type":"array"},"name":{"type":"string"},"template_id":{"type":"integer"},"translation":{"type":"string"}},"type":"object"}},"required":["data_structure_type"],"title":"DataStructureTypeUpdateRequest","type":"object"},"DataStructureTypeResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/DataStructureType"}},"required":["data"],"title":"DataStructureTypeResponse","type":"object"},"DataStructureType":{"additionalProperties":false,"properties":{"filters":{"items":{"type":"string"},"nullable":true,"type":"array"},"id":{"type":"integer"},"metadata_fields":{"items":{"type":"object"},"nullable":true,"type":"array"},"metadata_views":{"items":{"type":"object"},"nullable":true,"type":"array"},"name":{"type":"string"},"template":{"nullable":true,"properties":{"content":{"items":{"type":"object"},"nullable":true,"type":"array"},"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"template_id":{"nullable":true,"type":"integer"},"translation":{"nullable":true,"type":"string"}},"required":["id","name"],"title":"DataStructureType","type":"object"},"TdDdUnauthorizedResponse":{"anyOf":[{"$ref":"#/components/schemas/TdDdUnauthorizedMessageResponse"},{"$ref":"#/components/schemas/TdDdUnauthorizedErrorResponse"}],"description":"Unauthorized response from auth plug or error view","title":"TdDdUnauthorizedResponse"},"TdDdUnauthorizedMessageResponse":{"additionalProperties":false,"properties":{"message":{"type":"string"}},"required":["message"],"title":"TdDdUnauthorizedMessageResponse","type":"object"},"TdDdUnauthorizedErrorResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"required":["errors"],"title":"TdDdUnauthorizedErrorResponse","type":"object"},"TdDdForbiddenResponse":{"additionalProperties":false,"properties":{"errors":{"additionalProperties":false,"properties":{"detail":{"type":"string"}},"required":["detail"],"type":"object"}},"required":["errors"],"title":"TdDdForbiddenResponse","type":"object"},"TdDdUnprocessableEntityObjectResponse":{"additionalProperties":false,"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"required":["errors"],"title":"TdDdUnprocessableEntityObjectResponse","type":"object"},"TdDdInternalServerErrorResponse":{"additionalProperties":false,"properties":{"errors":{"additionalProperties":false,"properties":{"detail":{"type":"string"}},"required":["detail"],"type":"object"}},"required":["errors"],"title":"TdDdInternalServerErrorResponse","type":"object"}}}}
```

## Update data structure type

> Updates the specified data structure type with the provided payload.

```json
{"openapi":"3.0.0","info":{"title":"td-dd","version":"Truedat 8.8.2"},"paths":{"/api/data_structure_types/{id}":{"patch":{"description":"Updates the specified data structure type with the provided payload.","operationId":"TdDdWeb.DataStructureTypeController.update (2)","parameters":[{"description":"Data structure type ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataStructureTypeUpdateRequest"}}},"description":"Data structure type payload","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataStructureTypeResponse"}}},"description":"Data structure type updated"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdUnauthorizedResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdForbiddenResponse"}}},"description":"Forbidden"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdUnprocessableEntityObjectResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdInternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Update data structure type","tags":["Data Structure Types"]}}},"components":{"schemas":{"DataStructureTypeUpdateRequest":{"additionalProperties":false,"properties":{"data_structure_type":{"additionalProperties":false,"properties":{"filters":{"items":{"type":"string"},"type":"array"},"metadata_views":{"items":{"type":"object"},"type":"array"},"name":{"type":"string"},"template_id":{"type":"integer"},"translation":{"type":"string"}},"type":"object"}},"required":["data_structure_type"],"title":"DataStructureTypeUpdateRequest","type":"object"},"DataStructureTypeResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/DataStructureType"}},"required":["data"],"title":"DataStructureTypeResponse","type":"object"},"DataStructureType":{"additionalProperties":false,"properties":{"filters":{"items":{"type":"string"},"nullable":true,"type":"array"},"id":{"type":"integer"},"metadata_fields":{"items":{"type":"object"},"nullable":true,"type":"array"},"metadata_views":{"items":{"type":"object"},"nullable":true,"type":"array"},"name":{"type":"string"},"template":{"nullable":true,"properties":{"content":{"items":{"type":"object"},"nullable":true,"type":"array"},"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"template_id":{"nullable":true,"type":"integer"},"translation":{"nullable":true,"type":"string"}},"required":["id","name"],"title":"DataStructureType","type":"object"},"TdDdUnauthorizedResponse":{"anyOf":[{"$ref":"#/components/schemas/TdDdUnauthorizedMessageResponse"},{"$ref":"#/components/schemas/TdDdUnauthorizedErrorResponse"}],"description":"Unauthorized response from auth plug or error view","title":"TdDdUnauthorizedResponse"},"TdDdUnauthorizedMessageResponse":{"additionalProperties":false,"properties":{"message":{"type":"string"}},"required":["message"],"title":"TdDdUnauthorizedMessageResponse","type":"object"},"TdDdUnauthorizedErrorResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"required":["errors"],"title":"TdDdUnauthorizedErrorResponse","type":"object"},"TdDdForbiddenResponse":{"additionalProperties":false,"properties":{"errors":{"additionalProperties":false,"properties":{"detail":{"type":"string"}},"required":["detail"],"type":"object"}},"required":["errors"],"title":"TdDdForbiddenResponse","type":"object"},"TdDdUnprocessableEntityObjectResponse":{"additionalProperties":false,"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"required":["errors"],"title":"TdDdUnprocessableEntityObjectResponse","type":"object"},"TdDdInternalServerErrorResponse":{"additionalProperties":false,"properties":{"errors":{"additionalProperties":false,"properties":{"detail":{"type":"string"}},"required":["detail"],"type":"object"}},"required":["errors"],"title":"TdDdInternalServerErrorResponse","type":"object"}}}}
```

## List data structure types

> Returns all available data structure types that the current user can read.

```json
{"openapi":"3.0.0","info":{"title":"td-dd","version":"Truedat 8.8.2"},"paths":{"/api/data_structure_types":{"get":{"description":"Returns all available data structure types that the current user can read.","operationId":"TdDdWeb.DataStructureTypeController.index","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataStructureTypeListResponse"}}},"description":"Data structure type list"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdUnauthorizedResponse"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdInternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"List data structure types","tags":["Data Structure Types"]}}},"components":{"schemas":{"DataStructureTypeListResponse":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/DataStructureType"},"type":"array"}},"required":["data"],"title":"DataStructureTypeListResponse","type":"object"},"DataStructureType":{"additionalProperties":false,"properties":{"filters":{"items":{"type":"string"},"nullable":true,"type":"array"},"id":{"type":"integer"},"metadata_fields":{"items":{"type":"object"},"nullable":true,"type":"array"},"metadata_views":{"items":{"type":"object"},"nullable":true,"type":"array"},"name":{"type":"string"},"template":{"nullable":true,"properties":{"content":{"items":{"type":"object"},"nullable":true,"type":"array"},"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"template_id":{"nullable":true,"type":"integer"},"translation":{"nullable":true,"type":"string"}},"required":["id","name"],"title":"DataStructureType","type":"object"},"TdDdUnauthorizedResponse":{"anyOf":[{"$ref":"#/components/schemas/TdDdUnauthorizedMessageResponse"},{"$ref":"#/components/schemas/TdDdUnauthorizedErrorResponse"}],"description":"Unauthorized response from auth plug or error view","title":"TdDdUnauthorizedResponse"},"TdDdUnauthorizedMessageResponse":{"additionalProperties":false,"properties":{"message":{"type":"string"}},"required":["message"],"title":"TdDdUnauthorizedMessageResponse","type":"object"},"TdDdUnauthorizedErrorResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"required":["errors"],"title":"TdDdUnauthorizedErrorResponse","type":"object"},"TdDdInternalServerErrorResponse":{"additionalProperties":false,"properties":{"errors":{"additionalProperties":false,"properties":{"detail":{"type":"string"}},"required":["detail"],"type":"object"}},"required":["errors"],"title":"TdDdInternalServerErrorResponse","type":"object"}}}}
```