Notes

Delete Note

Changed on

Delete a note. Supports optimistic concurrency via If-Match.

delete/notes/{note_id}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /notes/{note_id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /authorize, token URL /oauth/token)

Path parameters

note_idstring required

ID of the note.

Example:note_6968b398edb465624291e405

Headers

if-matchstring nullable

Expected note revision (the ETag value); the request fails with 412 if the note has changed.

Example:"3"

Response

Successful Response

Changes

  • c516481e6ed8Revision changes
    • info

      the endpoint scheme security OAuth2 was added to the API

  • d65fcba0d25aRevision changes
    • breaking

      the response's property type changed from array to string for status

    • info

      api operation id delete_note_notes__note_id__delete removed and replaced with deleteNote

    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      the endpoint scheme security AgentOauthAccessToken was removed from the API

    • info

      the endpoint scheme security HumanLogin was removed from the API

    • info

      the endpoint scheme security JenticApiKey was removed from the API

    • info

      api tag Notes added

    • info

      api tag catalog removed

    • info

      added the new optional header request parameter if-match

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status