Table of Contents

• 1. Record field format
• 2. Associated attributes
• 3. Nomenclature
• 4. Actions
• 4.01 Index
• 4.02 Show
• 5. See also

The following includes the details of how to interface with the note version records through the API.

Record field format

Name	Type	Details
id	integer	>0
note_id	integer	>0
post_id	integer	>0
x	integer	>=0
y	integer	>=0
width	integer	>=0
height	integer	>=0
body	string
is_active	boolean
version	integer	>0
updater_id	integer	>0
created_at	timestamp
updated_at	timestamp
updater_addr_ip	inet	Limited to Moderator+

Associated attributes

Name	Type	Number	Availability	Details
note	note	single	required
post	post	single	required
updater	user	single	required

Nomenclature

• Plural form: "note_versions"
• Used in the URL pathname
• Singular form: "note_version"
• Unused
• Version of: API:Notes

Actions

These are the various actions that can be done with note version records.

Index

HTTP Method	GET or POST [1]
Base URL	/note_versions.json
Type	read request
Description	The default order is ID descending.

Search attributes

All of the following are standard attributes with all of their available formats and qualifiers.

• Number syntax
• id
• note_id
• post_id
• x
• y
• width
• height
• version
• created_at
• updated_at
• Text syntax
• body
• Boolean syntax
• is_active
• User syntax
• updater

Special search parameters

• post_tags_match - The post query of the search term matches the post of the note.
• body_matches - Case-insensitive wildcard search on the body field.

Show

HTTP Method	GET or POST [1]
Base URL	/note_versions/$id.json
Type	read request
Description	$id is the note version ID.

See also

[1] Help:API read requests

• Help:Common URL Parameters
• Help:API

View wiki