document
v1
GET /api/v1/document/document-notes/
Changed onDocument Note List
Request
- Base URL/ (relative, and the document was published on a file host, not at the API’s origin)
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
jq_filtersobject
Filter params similar to JQWidgets grid filter params: filterscount=1, filterdatafield0="a", filtervalue0="b", filtercondition0="CONTAINS", filteroperator0=1, sortdatafied="c", sortorder="asc"
project_idstring
Filter by project id
document_idstring
Filter by document id
forceboolean
For deleted documents as well
export_toboolean
Export data
Response
Example response
[
{
"field_id": "field_id",
"note": "note",
"selections": [
"{}",
"{}"
],
"location_start": -1517921766,
"location_end": 413233370,
"pk": 0,
"field_value_id": 2,
"document_id": 5,
"user": {
"initials": "initials",
"name": "name",
"last_name": "last_name",
"photo": "photo",
"pk": 6,
"first_name": "first_name",
"username": "username"
},
"timestamp": "2000-01-23T04:56:07.000+00:00"
}
]Changes
- info
added the optional property
//to the response with the status
- info
- warning
removed the optional property
//from the response with the status - info
added the optional property
/to the response with the status
- warning