pageannotation

Changed on
get/api/v1/pageannotation/{id}/

Request

  • The document declares no server URL.
  • Auth: API key in cookie sessionid

Path parameters

idinteger required

A unique integer value identifying this page annotation.

Query parameters

format'csv' | 'json'

Response

idinteger required
titlestring
descriptionstring
topinteger nullable
leftinteger nullable
widthinteger nullable
heightinteger nullable
timestampstring date-time required
can_deleteboolean required
highlightstring required
imagestring uri required
documentstring uri required
numberinteger required

Changes

  • 2ba1a8b828b8Revision changes
    • info

      the response optional property became read-only for the status (media type: application/json)

    • info

      the response optional property became read-only for the status (media type: text/csv)

    • info

      the response optional property became read-only for the status (media type: application/json)

    • info

      the response optional property became read-only for the status (media type: text/csv)

    • info

      the response optional property became read-only for the status (media type: application/json)

    • info

      the response optional property became read-only for the status (media type: text/csv)

    • info

      the response property became required for the status (media type: application/json)

    • info

      the response property became required for the status (media type: text/csv)

    • info

      the response property became required for the status (media type: application/json)

    • info

      the response property became required for the status (media type: text/csv)

    • info

      the response property became required for the status (media type: application/json)

    • info

      the response property became required for the status (media type: text/csv)

  • f5a1531aecbeRevision changes
    • breaking

      for the path request parameter id, the type changed from string to integer

    • breaking

      the response's property format changed from binary to uri for status (media type: application/json)

    • breaking

      the response's property format changed from binary to uri for status (media type: text/csv)

    • info

      api operation id retrievePageAnnotation removed and replaced with pageannotation_retrieve

    • info

      the endpoint scheme security cookieAuth was added to the API

    • info

      api tag pageannotation added

    • info

      api tag api removed

    • info

      added the new optional query request parameter format

    • info

      the response property became required for the status (media type: application/json)

    • info

      the response property became required for the status (media type: text/csv)

    • info

      the response property became required for the status (media type: application/json)

    • info

      the response property became required for the status (media type: text/csv)

    • info

      the response property became required for the status (media type: application/json)

    • info

      the response property became required for the status (media type: text/csv)

    • info

      the response property became required for the status (media type: application/json)

    • info

      the response property became required for the status (media type: text/csv)