Sign in
upload

Changed on
patch/api/v1/upload/{guid}/

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (scopes: write:attachment)
    • API key in cookie sessionid

Path parameters

guidstring required

Query parameters

format'csv' | 'json'

Response

idinteger required
guidstring uuid required
state'initial' | 'receiving' | 'saving' | 'done'
  • initial - Initial
  • receiving - Receiving
  • saving - Saving
  • done - Done
upload_offsetinteger
upload_lengthinteger
upload_metadatastring
filenamestring
temporary_file_pathstring nullable
expiresstring date-time nullable
tokenstring uuid nullable
userinteger nullable

Changes

  • 2ba1a8b828b8Revision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

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

    • breaking

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

    • warning

      added the new done enum value to the response property for the response status (media type: application/json)

    • warning

      added the new done enum value to the response property for the response status (media type: text/csv)

    • warning

      added the new initial enum value to the response property for the response status (media type: application/json)

    • warning

      added the new initial enum value to the response property for the response status (media type: text/csv)

    • warning

      added the new receiving enum value to the response property for the response status (media type: application/json)

    • warning

      added the new receiving enum value to the response property for the response status (media type: text/csv)

    • warning

      added the new saving enum value to the response property for the response status (media type: application/json)

    • warning

      added the new saving enum value to the response property for the response status (media type: text/csv)

    • info

      added the new done enum value to the request property

    • info

      added the new initial enum value to the request property

    • info

      added the new receiving enum value to the request property

    • info

      added the new saving enum value to the request property

  • a3cbf0272cecRevision changes
    • info

      the security scope write:attachment was added to the endpoint's security scheme oauth2

    • info

      the security scope upload:message was removed from the endpoint's security scheme oauth2