cURL

curl --request GET \
  --url https://{server}/api/assets/{id}/markdown-note/ \
  --cookie sessionid=

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "author": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "email": "jsmith@example.com"
  },
  "content": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Get apiassets markdown note

Single free-form markdown note per asset.

Permissions reuse the existing READ_NOTES / WRITE_NOTES flags — callers who can already see comments on the asset can also see this note.

PUT semantics: idempotent upsert. The first PUT on an asset creates the note (201) and stamps author = request.user. Subsequent PUTs update only the content field (200) and do NOT refresh the author. Authorship records who originally wrote the note, not who last edited it — preserving history of who introduced the content. If a per-edit author trail becomes a requirement, add an updated_by FK; do not silently overwrite author on edit.

GET

api

assets

{id}

markdown-note

cURL

curl --request GET \
  --url https://{server}/api/assets/{id}/markdown-note/ \
  --cookie sessionid=

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "author": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "email": "jsmith@example.com"
  },
  "content": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

sessionid

string

required

Path Parameters

string<uuid>

required

Response

string<uuid>

required

read-only

author

object

required

Show child attributes

content

string

required

read-only

created_at

string<date-time>

required

read-only

updated_at

string<date-time>

required

read-only

Post apiassets lock

Put apiassets markdown note

⌘I