Updating a VDS Document

This API allows you to update the content of the VDS document.

Request

  • HTTP Method:PUT
  • Example URL:Application_URL/services/api/v1/documents/vds/{vdsDocumentId}
  • Authorization:You must have the roles DOCUMENT_EDIT or DOCUMENT_DELETE assigned to your user ID in the SAP HANA Cloud Platform account.
  • Schema:You must use a form data to upload a new attachment rather than using a JSON schema. The fields of the form data are described in the table below:
Parameters used in the Form Data

Field Name (Mandatory or Optional)

Data Type

Description and Possible Values

file (Mandatory)

File

Specifies the file that you want to upload.

file-data (Mandatory)

JSON

file:Converted data of the image.

vdsDocumentIdSpecifies the document ID the system generates for a document for which you want to update.

fileNameSpecifies the name of the file.

encodedSnapshotImage the Base64 encoded image of the VDS, to uploaded as a snaphot fo the VDS.

Response

The system generates a unique document ID after the successful execution of the service. For more information on the response schema and the corresponding status codes, see RAML definitions at https://help.sap.com/doc/c8af652c31a6435baf13e424539276d4/1902/en-US/documents.html#documents_vds__vdsDocumentId__put.