LElexpredict
document
v1

PATCH /api/v1/document/document-notes/{id}/

Changed on

Partial Update Document Note

Request

Path parameters

idstring required

A unique integer value identifying this document note.

Request body

pkinteger
notestring required
timestampstring date-time
location_startinteger nullable
location_endinteger nullable
document_idinteger required
field_value_idinteger
field_idstring
selectionsobject[]

Example request

{
  "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"
}

Response

pkinteger
notestring required
timestampstring date-time
location_startinteger nullable
location_endinteger nullable
document_idinteger required
field_value_idinteger
field_idstring
selectionsobject[]

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

  • 63116f2e9e3eRevision changes
    • info

      added the new optional request property / (media type: application/json)

    • info

      added the new optional request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property / (media type: multipart/form-data)

    • info

      added the optional property / to the response with the status

  • 8167164be9ccRevision changes
    • warning

      removed the request property / (media type: application/json)

    • warning

      removed the request property / (media type: application/x-www-form-urlencoded)

    • warning

      removed the request property / (media type: multipart/form-data)

    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property to the response with the status