document

Changed on
patch/api/v1/document/{id}/

Request

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

Path parameters

idstring required

Query parameters

format'csv' | 'json'

Request body

resource_uristring uri
idinteger
site_urlstring
titlestring
slugstring
descriptionstring
published_atstring date-time nullable
num_pagesinteger
publicboolean
listedboolean
allow_annotationboolean
pendingboolean
file_urlstring
file_sizeinteger nullable
cover_imagestring
page_templatestring
outlinestring
propertiesunknown
uidstring uuid
dataunknown
pages_uristring

Response

resource_uristring uri required
idinteger required
site_urlstring required
titlestring
slugstring required
descriptionstring
published_atstring date-time nullable required
num_pagesinteger required
publicboolean required
listedboolean required
allow_annotationboolean required
pendingboolean required
file_urlstring required
file_sizeinteger nullable required
cover_imagestring required
page_templatestring required
outlinestring required
propertiesunknown required
uidstring uuid required
dataunknown required
pages_uristring required
originalstring uri required
foirequeststring uri required
publicbodystring uri required
last_modified_atstring required

Changes

  • 2ba1a8b828b8Revision changes
    • breaking

      the response property's maxLength was unset from 250 for the response status (media type: application/json)

    • breaking

      the response property's maxLength was unset from 250 for the response status (media type: text/csv)

    • breaking

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

    • breaking

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

    • info

      the request optional property became read-only (media type: application/json)

    • info

      the request optional property became read-only (media type: application/x-www-form-urlencoded)

    • info

      the request optional property became read-only (media type: multipart/form-data)

    • info

      the request optional property became read-only (media type: application/json)

    • info

      the request optional property became read-only (media type: application/x-www-form-urlencoded)

    • info

      the request optional property became read-only (media type: multipart/form-data)

    • info

      the request optional property became read-only (media type: application/json)

    • info

      the request optional property became read-only (media type: application/x-www-form-urlencoded)

    • info

      the request optional property became read-only (media type: multipart/form-data)

    • info

      the request optional property became read-only (media type: application/json)

    • info

      the request optional property became read-only (media type: application/x-www-form-urlencoded)

    • info

      the request optional property became read-only (media type: multipart/form-data)

    • info

      the request optional property became read-only (media type: application/json)

    • info

      the request optional property became read-only (media type: application/x-www-form-urlencoded)

    • info

      the request optional property became read-only (media type: multipart/form-data)

    • info

      the request optional property became read-only (media type: application/json)

    • info

      the request optional property became read-only (media type: application/x-www-form-urlencoded)

    • info

      the request optional property became read-only (media type: multipart/form-data)

    • info

      the request optional property became read-only (media type: application/json)

    • info

      the request optional property became read-only (media type: application/x-www-form-urlencoded)

    • info

      the request optional property became read-only (media type: multipart/form-data)

    • info

      the request optional property became read-only (media type: application/json)

    • info

      the request optional property became read-only (media type: application/x-www-form-urlencoded)

    • info

      the request optional property became read-only (media type: multipart/form-data)

    • info

      the request optional property became read-only (media type: application/json)

    • info

      the request optional property became read-only (media type: application/x-www-form-urlencoded)

    • info

      the request optional property became read-only (media type: multipart/form-data)

    • info

      the request optional property became read-only (media type: application/json)

    • info

      the request optional property became read-only (media type: application/x-www-form-urlencoded)

    • info

      the request optional property became read-only (media type: multipart/form-data)

    • info

      the request optional property became read-only (media type: application/json)

    • info

      the request optional property became read-only (media type: application/x-www-form-urlencoded)

    • info

      the request optional property became read-only (media type: multipart/form-data)

    • 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 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 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 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)

    • 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)

    • 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)

  • f5a1531aecbeRevision changes
    • breaking

      the request property type changed from object to no type (media type: application/json)

    • breaking

      the request property type changed from object to no type (media type: application/json)

    • breaking

      the response's property type changed from object to no type for status (media type: application/json)

    • breaking

      the response's property type changed from object to no type for status (media type: text/csv)

    • breaking

      the response's property type changed from object to no type for status (media type: application/json)

    • breaking

      the response's property type changed from object to no type for status (media type: text/csv)

    • warning

      deleted the query request parameter collection

    • warning

      deleted the query request parameter created_at

    • warning

      deleted the query request parameter directory

    • warning

      deleted the query request parameter foirequest

    • warning

      deleted the query request parameter ids

    • warning

      deleted the query request parameter portal

    • warning

      deleted the query request parameter publicbody

    • warning

      deleted the query request parameter tag

    • info

      api operation id partialUpdateDocument removed and replaced with document_partial_update

    • info

      the endpoint scheme security cookieAuth was added to the API

    • info

      api tag document added

    • info

      api tag api removed

    • info

      added the new optional query request parameter format

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      the request property type was generalized from object to no type (media type: application/x-www-form-urlencoded)

    • info

      the request property type was generalized from object to no type (media type: multipart/form-data)

    • info

      the request property type was generalized from object to no type (media type: application/x-www-form-urlencoded)

    • info

      the request property type was generalized from object to no type (media type: multipart/form-data)

    • 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)

    • 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

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: text/csv)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: text/csv)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: text/csv)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: text/csv)