Uploading a VDS Document

This API allows you to upload documents in VDS format.

Request

HTTP Method: POST using form data
Example URL:Application_URL/services/api/v1/documents/vds
Authorization:You must have the roles DOCUMENT_EDIT and 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 document 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	name: Name of the image to create corresponding to the VDS file.file: Converted data of the image. phaseCode Specifies the phases for which the document is relevant to in the lifecycle of a business object such as a model, an equipment, or a business entity such as an instruction, or an announcement. The possible values for the phases are provided in the table Phase Codes and Category Codes. categoryCodeSpecifies categorycode that corresponds to a phasecode. For the possible values of categoryCode, see Table Phase Codes and Category Codes. descriptionSpecifies the description of the document. languageSpecifies the language of the document.The possible values for the phase are provided in the table Language Codes. fileNameSpecifies the name of the file. confidentiality specifies if the document is visible to everyone or is only for internal use. dataSensitivity specifies if any sensitive information is available in the document encodedSnapshotImage the Base64 encoded image of the VDS, to uploaded as a snaphot fo the VDS.

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_post.