Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Data Structure Notes

Create structure note by external data structure id

post

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

Body
Responses
201

Structure note created

application/json
post/api/data_structure_notes
POST /api/data_structure_notes HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "structure_note": {
    "data_structure_external_id": "ds_customer_email",
    "df_content": {
      "field_name": "value"
    }
  }
}
{
  "_actions": {
    "draft": {
      "href": "/api/data_structures/123/notes",
      "input": {
        "df_content": {}
      },
      "method": "POST"
    }
  },
  "data": {
    "data_structure_id": 123,
    "df_content": {
      "field_name": "value"
    },
    "id": 1,
    "status": "published",
    "updated_at": "2026-06-18T10:00:00Z",
    "version": 2
  }
}

Get note suggestions

get

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

Path parameters
data_structure_idintegerRequired

Data structure ID

Query parameters
languagestringOptional

Language for suggestions (e.g., 'en', 'es')

Responses
200

Suggestions

application/json
get/api/data_structures/{data_structure_id}/note_suggestions
GET /api/data_structures/{data_structure_id}/note_suggestions HTTP/1.1
Accept: */*

{
  "data": {
    "field_name": [
      "suggestion1",
      "suggestion2"
    ]
  }
}

Search structure notes

post

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

Body
data_structure_idinteger · nullableOptional

Filter by data structure ID

querystring · nullableOptional

Search query text

sizeinteger · min: 1 · max: 100 · nullableOptional

Number of results per page

statusstring · enum · nullableOptional

Filter by status

Possible values:
system_idinteger · nullableOptional

Filter by system ID

untilstring · nullableOptional

Filter by update timestamp (upper bound)

updated_atstring · nullableOptional

Filter by update timestamp

Responses
200

Structure note search response

application/json
post/api/data_structure_notes/search
POST /api/data_structure_notes/search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "query": "customer",
  "size": 20,
  "status": "published"
}
{
  "data": [
    {
      "data_structure_external_id": "ds_customer_email",
      "data_structure_id": 123,
      "df_content": {
        "field_name": "value"
      },
      "id": 1,
      "status": "published",
      "updated_at": "2026-06-18T10:00:00Z",
      "version": 2
    }
  ]
}

List structure notes

get

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

Path parameters
data_structure_idintegerRequired

Data structure ID

Responses
200

Structure notes

application/json
get/api/data_structures/{data_structure_id}/notes
GET /api/data_structures/{data_structure_id}/notes HTTP/1.1
Accept: */*

{
  "_actions": {
    "draft": {
      "href": "/api/data_structures/123/notes",
      "input": {
        "df_content": {}
      },
      "method": "POST"
    }
  },
  "data": [
    {
      "data_structure_id": 123,
      "df_content": {
        "field_name": "value"
      },
      "id": 1,
      "status": "published",
      "updated_at": "2026-06-18T10:00:00Z",
      "version": 2
    }
  ]
}

Create structure note

post

Creates a new structure note for the specified data structure.

Path parameters
data_structure_idintegerRequired

Data structure ID

Body
Responses
201

Structure note

application/json
post/api/data_structures/{data_structure_id}/notes
POST /api/data_structures/{data_structure_id}/notes HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "structure_note": {
    "df_content": {
      "field_name": "value"
    }
  }
}
{
  "_actions": {
    "draft": {
      "href": "/api/data_structures/123/notes",
      "input": {
        "df_content": {}
      },
      "method": "POST"
    }
  },
  "data": {
    "data_structure_id": 123,
    "df_content": {
      "field_name": "value"
    },
    "id": 1,
    "status": "published",
    "updated_at": "2026-06-18T10:00:00Z",
    "version": 2
  }
}

Show structure note

get

Retrieves the specified structure note and returns its details.

Path parameters
data_structure_idintegerRequired

Data structure ID

idintegerRequired

Structure note ID

Responses
200

Structure note

application/json
get/api/data_structures/{data_structure_id}/notes/{id}
GET /api/data_structures/{data_structure_id}/notes/{id} HTTP/1.1
Accept: */*

{
  "_actions": {
    "draft": {
      "href": "/api/data_structures/123/notes",
      "input": {
        "df_content": {}
      },
      "method": "POST"
    }
  },
  "data": {
    "data_structure_id": 123,
    "df_content": {
      "field_name": "value"
    },
    "id": 1,
    "status": "published",
    "updated_at": "2026-06-18T10:00:00Z",
    "version": 2
  }
}

Update structure note

put

Updates the specified structure note with the provided payload.

Path parameters
data_structure_idintegerRequired

Data structure ID

idintegerRequired

Structure note ID

Body
Responses
200

Structure note updated

application/json
put/api/data_structures/{data_structure_id}/notes/{id}
PUT /api/data_structures/{data_structure_id}/notes/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "structure_note": {
    "df_content": {
      "field_name": "updated_value"
    },
    "status": "published"
  }
}
{
  "_actions": {
    "draft": {
      "href": "/api/data_structures/123/notes",
      "input": {
        "df_content": {}
      },
      "method": "POST"
    }
  },
  "data": {
    "data_structure_id": 123,
    "df_content": {
      "field_name": "value"
    },
    "id": 1,
    "status": "published",
    "updated_at": "2026-06-18T10:00:00Z",
    "version": 2
  }
}

Delete structure note

delete

Deletes the specified structure note.

Path parameters
data_structure_idintegerRequired

Data structure ID

idintegerRequired

Structure note ID

Responses
204

Structure note deleted

No content
delete/api/data_structures/{data_structure_id}/notes/{id}
DELETE /api/data_structures/{data_structure_id}/notes/{id} HTTP/1.1
Accept: */*

No content

Update structure note

patch

Updates the specified structure note with the provided payload.

Path parameters
data_structure_idintegerRequired

Data structure ID

idintegerRequired

Structure note ID

Body
Responses
200

Structure note updated

application/json
patch/api/data_structures/{data_structure_id}/notes/{id}
PATCH /api/data_structures/{data_structure_id}/notes/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "structure_note": {
    "df_content": {
      "field_name": "updated_value"
    },
    "status": "published"
  }
}
{
  "_actions": {
    "draft": {
      "href": "/api/data_structures/123/notes",
      "input": {
        "df_content": {}
      },
      "method": "POST"
    }
  },
  "data": {
    "data_structure_id": 123,
    "df_content": {
      "field_name": "value"
    },
    "id": 1,
    "status": "published",
    "updated_at": "2026-06-18T10:00:00Z",
    "version": 2
  }
}

Last updated