> 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-notes.md).

# Data Structure Notes

## Create structure note by external data structure id

> Creates a structure note for the specified external data structure ID.

```json
{"openapi":"3.0.0","info":{"title":"td-dd","version":"Truedat 8.8.2"},"paths":{"/api/data_structure_notes":{"post":{"description":"Creates a structure note for the specified external data structure ID.","operationId":"TdDdWeb.StructureNoteController.create_by_external_id","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureNoteCreateByExternalIdRequest"}}},"description":"Structure note create payload","required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureNoteResponse"}}},"description":"Structure note created"},"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":"Create structure note by external data structure id","tags":["Data Structure Notes"]}}},"components":{"schemas":{"StructureNoteCreateByExternalIdRequest":{"additionalProperties":false,"properties":{"structure_note":{"additionalProperties":false,"properties":{"data_structure_external_id":{"description":"External ID of the data structure","type":"string"},"df_content":{"additionalProperties":true,"description":"Note content (dynamic based on template)","type":"object"},"domain_ids":{"description":"Domain IDs (virtual field, ignored)","items":{"type":"integer"},"nullable":true,"type":"array"},"resource":{"additionalProperties":true,"description":"Resource metadata (virtual field, ignored)","nullable":true,"type":"object"},"status":{"description":"Status (virtual field, ignored)","enum":["draft","pending_approval","rejected","published","versioned","deprecated"],"nullable":true,"type":"string"},"version":{"description":"Version number (virtual field, assigned automatically)","nullable":true,"type":"integer"}},"required":["data_structure_external_id","df_content"],"type":"object"}},"required":["structure_note"],"title":"StructureNoteCreateByExternalIdRequest","type":"object"},"StructureNoteResponse":{"additionalProperties":false,"properties":{"_actions":{"additionalProperties":true,"description":"Available actions for the structure","nullable":true,"type":"object"},"data":{"$ref":"#/components/schemas/StructureNoteResource"}},"required":["data"],"title":"StructureNoteResponse","type":"object"},"StructureNoteResource":{"additionalProperties":false,"properties":{"_actions":{"additionalProperties":true,"description":"Available actions","nullable":true,"type":"object"},"_diff":{"description":"Fields changed in draft","items":{"type":"string"},"nullable":true,"type":"array"},"data_structure_external_id":{"description":"Data structure external ID","nullable":true,"type":"string"},"data_structure_id":{"description":"Data structure ID","nullable":true,"type":"integer"},"df_content":{"additionalProperties":true,"description":"Displayable content (flattened)","type":"object"},"dynamic_content":{"additionalProperties":true,"description":"Raw content with metadata","nullable":true,"type":"object"},"id":{"description":"Note ID","type":"integer"},"inserted_at":{"description":"Creation timestamp","nullable":true,"type":"string"},"status":{"description":"Status of the note","enum":["draft","pending_approval","published","rejected","versioned","deprecated"],"type":"string"},"template_id":{"description":"Template ID","nullable":true,"type":"integer"},"updated_at":{"description":"Last update timestamp","nullable":true,"type":"string"},"version":{"description":"Version number","type":"integer"}},"required":["id","status","version"],"title":"StructureNoteResource","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"}}}}
```

## Get note suggestions

> Returns AI-generated note suggestions for the specified data structure.

```json
{"openapi":"3.0.0","info":{"title":"td-dd","version":"Truedat 8.8.2"},"paths":{"/api/data_structures/{data_structure_id}/note_suggestions":{"get":{"description":"Returns AI-generated note suggestions for the specified data structure.","operationId":"TdDdWeb.StructureNoteController.note_suggestions","parameters":[{"description":"Data structure ID","in":"path","name":"data_structure_id","required":true,"schema":{"type":"integer"}},{"description":"Language for suggestions (e.g., 'en', 'es')","in":"query","name":"language","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureNoteSuggestionsResponse"}}},"description":"Suggestions"},"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":"Get note suggestions","tags":["Data Structure Notes"]}}},"components":{"schemas":{"StructureNoteSuggestionsResponse":{"additionalProperties":false,"properties":{"data":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Map of field names to suggested values","type":"object"}},"required":["data"],"title":"StructureNoteSuggestionsResponse","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"}}}}
```

## Search structure notes

> Searches structure notes using the provided filters and returns matching results.

```json
{"openapi":"3.0.0","info":{"title":"td-dd","version":"Truedat 8.8.2"},"paths":{"/api/data_structure_notes/search":{"post":{"description":"Searches structure notes using the provided filters and returns matching results.","operationId":"TdDdWeb.StructureNoteController.search","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureNoteSearchRequest"}}},"description":"Structure note search filters","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureNoteSearchResponse"}}},"description":"Structure note search response"},"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":"Search structure notes","tags":["Data Structure Notes"]}}},"components":{"schemas":{"StructureNoteSearchRequest":{"additionalProperties":false,"properties":{"data_structure_id":{"description":"Filter by data structure ID","nullable":true,"type":"integer"},"query":{"description":"Search query text","nullable":true,"type":"string"},"size":{"description":"Number of results per page","maximum":100,"minimum":1,"nullable":true,"type":"integer"},"status":{"description":"Filter by status","enum":["draft","pending_approval","published","rejected","versioned","deprecated"],"nullable":true,"type":"string"},"system_id":{"description":"Filter by system ID","nullable":true,"type":"integer"},"until":{"description":"Filter by update timestamp (upper bound)","nullable":true,"type":"string"},"updated_at":{"description":"Filter by update timestamp","nullable":true,"type":"string"}},"title":"StructureNoteSearchRequest","type":"object"},"StructureNoteSearchResponse":{"additionalProperties":false,"properties":{"data":{"description":"List of structure notes matching the search","items":{"$ref":"#/components/schemas/StructureNoteResource"},"type":"array"}},"required":["data"],"title":"StructureNoteSearchResponse","type":"object"},"StructureNoteResource":{"additionalProperties":false,"properties":{"_actions":{"additionalProperties":true,"description":"Available actions","nullable":true,"type":"object"},"_diff":{"description":"Fields changed in draft","items":{"type":"string"},"nullable":true,"type":"array"},"data_structure_external_id":{"description":"Data structure external ID","nullable":true,"type":"string"},"data_structure_id":{"description":"Data structure ID","nullable":true,"type":"integer"},"df_content":{"additionalProperties":true,"description":"Displayable content (flattened)","type":"object"},"dynamic_content":{"additionalProperties":true,"description":"Raw content with metadata","nullable":true,"type":"object"},"id":{"description":"Note ID","type":"integer"},"inserted_at":{"description":"Creation timestamp","nullable":true,"type":"string"},"status":{"description":"Status of the note","enum":["draft","pending_approval","published","rejected","versioned","deprecated"],"type":"string"},"template_id":{"description":"Template ID","nullable":true,"type":"integer"},"updated_at":{"description":"Last update timestamp","nullable":true,"type":"string"},"version":{"description":"Version number","type":"integer"}},"required":["id","status","version"],"title":"StructureNoteResource","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"}}}}
```

## List structure notes

> Lists all structure notes for the specified data structure and includes available actions for the current user.

```json
{"openapi":"3.0.0","info":{"title":"td-dd","version":"Truedat 8.8.2"},"paths":{"/api/data_structures/{data_structure_id}/notes":{"get":{"description":"Lists all structure notes for the specified data structure and includes available actions for the current user.","operationId":"TdDdWeb.StructureNoteController.index","parameters":[{"description":"Data structure ID","in":"path","name":"data_structure_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureNoteIndexResponse"}}},"description":"Structure notes"},"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":"List structure notes","tags":["Data Structure Notes"]}}},"components":{"schemas":{"StructureNoteIndexResponse":{"additionalProperties":false,"properties":{"_actions":{"additionalProperties":{"$ref":"#/components/schemas/StructureNoteAction"},"description":"Available actions for the structure","nullable":true,"type":"object"},"data":{"description":"List of structure notes","items":{"$ref":"#/components/schemas/StructureNoteResource"},"type":"array"}},"required":["data"],"title":"StructureNoteIndexResponse","type":"object"},"StructureNoteAction":{"additionalProperties":false,"properties":{"href":{"description":"Action URL","type":"string"},"id":{"description":"Note ID","nullable":true,"type":"integer"},"input":{"additionalProperties":true,"description":"Required input for the action","nullable":true,"type":"object"},"method":{"description":"HTTP method","enum":["POST","GET","PATCH","DELETE"],"type":"string"}},"required":["href","method"],"title":"StructureNoteAction","type":"object"},"StructureNoteResource":{"additionalProperties":false,"properties":{"_actions":{"additionalProperties":true,"description":"Available actions","nullable":true,"type":"object"},"_diff":{"description":"Fields changed in draft","items":{"type":"string"},"nullable":true,"type":"array"},"data_structure_external_id":{"description":"Data structure external ID","nullable":true,"type":"string"},"data_structure_id":{"description":"Data structure ID","nullable":true,"type":"integer"},"df_content":{"additionalProperties":true,"description":"Displayable content (flattened)","type":"object"},"dynamic_content":{"additionalProperties":true,"description":"Raw content with metadata","nullable":true,"type":"object"},"id":{"description":"Note ID","type":"integer"},"inserted_at":{"description":"Creation timestamp","nullable":true,"type":"string"},"status":{"description":"Status of the note","enum":["draft","pending_approval","published","rejected","versioned","deprecated"],"type":"string"},"template_id":{"description":"Template ID","nullable":true,"type":"integer"},"updated_at":{"description":"Last update timestamp","nullable":true,"type":"string"},"version":{"description":"Version number","type":"integer"}},"required":["id","status","version"],"title":"StructureNoteResource","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"}}}}
```

## Create structure note

> Creates a new structure note for the specified data structure.

```json
{"openapi":"3.0.0","info":{"title":"td-dd","version":"Truedat 8.8.2"},"paths":{"/api/data_structures/{data_structure_id}/notes":{"post":{"description":"Creates a new structure note for the specified data structure.","operationId":"TdDdWeb.StructureNoteController.create","parameters":[{"description":"Data structure ID","in":"path","name":"data_structure_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureNoteCreateRequest"}}},"description":"Structure note","required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureNoteResponse"}}},"description":"Structure note"},"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/DDUnprocessableEntityVariableResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDdInternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Create structure note","tags":["Data Structure Notes"]}}},"components":{"schemas":{"StructureNoteCreateRequest":{"additionalProperties":false,"properties":{"structure_note":{"additionalProperties":false,"properties":{"df_content":{"additionalProperties":true,"description":"Note content (dynamic based on template)","type":"object"},"domain_ids":{"description":"Domain IDs (virtual field, ignored in creation)","items":{"type":"integer"},"nullable":true,"type":"array"},"resource":{"additionalProperties":true,"description":"Resource metadata (virtual field, ignored)","nullable":true,"type":"object"},"status":{"description":"Status (virtual field, ignored in creation)","enum":["draft","pending_approval","rejected","published","versioned","deprecated"],"nullable":true,"type":"string"},"version":{"description":"Version number (virtual field, assigned automatically)","nullable":true,"type":"integer"}},"required":["df_content"],"type":"object"}},"required":["structure_note"],"title":"StructureNoteCreateRequest","type":"object"},"StructureNoteResponse":{"additionalProperties":false,"properties":{"_actions":{"additionalProperties":true,"description":"Available actions for the structure","nullable":true,"type":"object"},"data":{"$ref":"#/components/schemas/StructureNoteResource"}},"required":["data"],"title":"StructureNoteResponse","type":"object"},"StructureNoteResource":{"additionalProperties":false,"properties":{"_actions":{"additionalProperties":true,"description":"Available actions","nullable":true,"type":"object"},"_diff":{"description":"Fields changed in draft","items":{"type":"string"},"nullable":true,"type":"array"},"data_structure_external_id":{"description":"Data structure external ID","nullable":true,"type":"string"},"data_structure_id":{"description":"Data structure ID","nullable":true,"type":"integer"},"df_content":{"additionalProperties":true,"description":"Displayable content (flattened)","type":"object"},"dynamic_content":{"additionalProperties":true,"description":"Raw content with metadata","nullable":true,"type":"object"},"id":{"description":"Note ID","type":"integer"},"inserted_at":{"description":"Creation timestamp","nullable":true,"type":"string"},"status":{"description":"Status of the note","enum":["draft","pending_approval","published","rejected","versioned","deprecated"],"type":"string"},"template_id":{"description":"Template ID","nullable":true,"type":"integer"},"updated_at":{"description":"Last update timestamp","nullable":true,"type":"string"},"version":{"description":"Version number","type":"integer"}},"required":["id","status","version"],"title":"StructureNoteResource","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"},"DDUnprocessableEntityVariableResponse":{"description":"Response for 422 errors. Error messages might have different formats","oneOf":[{"$ref":"#/components/schemas/TdDdUnprocessableEntityStringResponse"},{"$ref":"#/components/schemas/TdDdUnprocessableEntityArrayResponse"},{"$ref":"#/components/schemas/TdDdUnprocessableEntityObjectResponse"}],"title":"DDUnprocessableEntityVariableResponse"},"TdDdUnprocessableEntityStringResponse":{"additionalProperties":false,"properties":{"error":{"type":"string"},"message":{"type":"string"}},"title":"TdDdUnprocessableEntityStringResponse","type":"object"},"TdDdUnprocessableEntityArrayResponse":{"additionalProperties":false,"properties":{"error":{"items":{"type":"string"},"type":"array"},"errors":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"type":"object"},"type":"array"}},"title":"TdDdUnprocessableEntityArrayResponse","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"}}}}
```

## Show structure note

> Retrieves the specified structure note and returns its details.

```json
{"openapi":"3.0.0","info":{"title":"td-dd","version":"Truedat 8.8.2"},"paths":{"/api/data_structures/{data_structure_id}/notes/{id}":{"get":{"description":"Retrieves the specified structure note and returns its details.","operationId":"TdDdWeb.StructureNoteController.show","parameters":[{"description":"Data structure ID","in":"path","name":"data_structure_id","required":true,"schema":{"type":"integer"}},{"description":"Structure note ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureNoteResponse"}}},"description":"Structure note"},"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":"Show structure note","tags":["Data Structure Notes"]}}},"components":{"schemas":{"StructureNoteResponse":{"additionalProperties":false,"properties":{"_actions":{"additionalProperties":true,"description":"Available actions for the structure","nullable":true,"type":"object"},"data":{"$ref":"#/components/schemas/StructureNoteResource"}},"required":["data"],"title":"StructureNoteResponse","type":"object"},"StructureNoteResource":{"additionalProperties":false,"properties":{"_actions":{"additionalProperties":true,"description":"Available actions","nullable":true,"type":"object"},"_diff":{"description":"Fields changed in draft","items":{"type":"string"},"nullable":true,"type":"array"},"data_structure_external_id":{"description":"Data structure external ID","nullable":true,"type":"string"},"data_structure_id":{"description":"Data structure ID","nullable":true,"type":"integer"},"df_content":{"additionalProperties":true,"description":"Displayable content (flattened)","type":"object"},"dynamic_content":{"additionalProperties":true,"description":"Raw content with metadata","nullable":true,"type":"object"},"id":{"description":"Note ID","type":"integer"},"inserted_at":{"description":"Creation timestamp","nullable":true,"type":"string"},"status":{"description":"Status of the note","enum":["draft","pending_approval","published","rejected","versioned","deprecated"],"type":"string"},"template_id":{"description":"Template ID","nullable":true,"type":"integer"},"updated_at":{"description":"Last update timestamp","nullable":true,"type":"string"},"version":{"description":"Version number","type":"integer"}},"required":["id","status","version"],"title":"StructureNoteResource","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"}}}}
```

## Update structure note

> Updates the specified structure note with the provided payload.

```json
{"openapi":"3.0.0","info":{"title":"td-dd","version":"Truedat 8.8.2"},"paths":{"/api/data_structures/{data_structure_id}/notes/{id}":{"put":{"description":"Updates the specified structure note with the provided payload.","operationId":"TdDdWeb.StructureNoteController.update","parameters":[{"description":"Data structure ID","in":"path","name":"data_structure_id","required":true,"schema":{"type":"integer"}},{"description":"Structure note ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureNoteUpdateRequest"}}},"description":"Structure note update payload","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureNoteResponse"}}},"description":"Structure note 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 structure note","tags":["Data Structure Notes"]}}},"components":{"schemas":{"StructureNoteUpdateRequest":{"additionalProperties":false,"properties":{"structure_note":{"additionalProperties":false,"properties":{"df_content":{"additionalProperties":true,"description":"Updated note content","nullable":true,"type":"object"},"status":{"description":"New status for the note","enum":["draft","pending_approval","published","rejected","deprecated"],"nullable":true,"type":"string"}},"type":"object"}},"required":["structure_note"],"title":"StructureNoteUpdateRequest","type":"object"},"StructureNoteResponse":{"additionalProperties":false,"properties":{"_actions":{"additionalProperties":true,"description":"Available actions for the structure","nullable":true,"type":"object"},"data":{"$ref":"#/components/schemas/StructureNoteResource"}},"required":["data"],"title":"StructureNoteResponse","type":"object"},"StructureNoteResource":{"additionalProperties":false,"properties":{"_actions":{"additionalProperties":true,"description":"Available actions","nullable":true,"type":"object"},"_diff":{"description":"Fields changed in draft","items":{"type":"string"},"nullable":true,"type":"array"},"data_structure_external_id":{"description":"Data structure external ID","nullable":true,"type":"string"},"data_structure_id":{"description":"Data structure ID","nullable":true,"type":"integer"},"df_content":{"additionalProperties":true,"description":"Displayable content (flattened)","type":"object"},"dynamic_content":{"additionalProperties":true,"description":"Raw content with metadata","nullable":true,"type":"object"},"id":{"description":"Note ID","type":"integer"},"inserted_at":{"description":"Creation timestamp","nullable":true,"type":"string"},"status":{"description":"Status of the note","enum":["draft","pending_approval","published","rejected","versioned","deprecated"],"type":"string"},"template_id":{"description":"Template ID","nullable":true,"type":"integer"},"updated_at":{"description":"Last update timestamp","nullable":true,"type":"string"},"version":{"description":"Version number","type":"integer"}},"required":["id","status","version"],"title":"StructureNoteResource","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"}}}}
```

## Delete structure note

> Deletes the specified structure note.

```json
{"openapi":"3.0.0","info":{"title":"td-dd","version":"Truedat 8.8.2"},"paths":{"/api/data_structures/{data_structure_id}/notes/{id}":{"delete":{"description":"Deletes the specified structure note.","operationId":"TdDdWeb.StructureNoteController.delete","parameters":[{"description":"Data structure ID","in":"path","name":"data_structure_id","required":true,"schema":{"type":"integer"}},{"description":"Structure note ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Structure note deleted"},"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":"Delete structure note","tags":["Data Structure Notes"]}}},"components":{"schemas":{"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 structure note

> Updates the specified structure note with the provided payload.

```json
{"openapi":"3.0.0","info":{"title":"td-dd","version":"Truedat 8.8.2"},"paths":{"/api/data_structures/{data_structure_id}/notes/{id}":{"patch":{"description":"Updates the specified structure note with the provided payload.","operationId":"TdDdWeb.StructureNoteController.update (2)","parameters":[{"description":"Data structure ID","in":"path","name":"data_structure_id","required":true,"schema":{"type":"integer"}},{"description":"Structure note ID","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureNoteUpdateRequest"}}},"description":"Structure note update payload","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureNoteResponse"}}},"description":"Structure note 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 structure note","tags":["Data Structure Notes"]}}},"components":{"schemas":{"StructureNoteUpdateRequest":{"additionalProperties":false,"properties":{"structure_note":{"additionalProperties":false,"properties":{"df_content":{"additionalProperties":true,"description":"Updated note content","nullable":true,"type":"object"},"status":{"description":"New status for the note","enum":["draft","pending_approval","published","rejected","deprecated"],"nullable":true,"type":"string"}},"type":"object"}},"required":["structure_note"],"title":"StructureNoteUpdateRequest","type":"object"},"StructureNoteResponse":{"additionalProperties":false,"properties":{"_actions":{"additionalProperties":true,"description":"Available actions for the structure","nullable":true,"type":"object"},"data":{"$ref":"#/components/schemas/StructureNoteResource"}},"required":["data"],"title":"StructureNoteResponse","type":"object"},"StructureNoteResource":{"additionalProperties":false,"properties":{"_actions":{"additionalProperties":true,"description":"Available actions","nullable":true,"type":"object"},"_diff":{"description":"Fields changed in draft","items":{"type":"string"},"nullable":true,"type":"array"},"data_structure_external_id":{"description":"Data structure external ID","nullable":true,"type":"string"},"data_structure_id":{"description":"Data structure ID","nullable":true,"type":"integer"},"df_content":{"additionalProperties":true,"description":"Displayable content (flattened)","type":"object"},"dynamic_content":{"additionalProperties":true,"description":"Raw content with metadata","nullable":true,"type":"object"},"id":{"description":"Note ID","type":"integer"},"inserted_at":{"description":"Creation timestamp","nullable":true,"type":"string"},"status":{"description":"Status of the note","enum":["draft","pending_approval","published","rejected","versioned","deprecated"],"type":"string"},"template_id":{"description":"Template ID","nullable":true,"type":"integer"},"updated_at":{"description":"Last update timestamp","nullable":true,"type":"string"},"version":{"description":"Version number","type":"integer"}},"required":["id","status","version"],"title":"StructureNoteResource","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"}}}}
```