Create Documents by Path
POST /ws/rest/service/v1/dm/document/create
Purpose
- Provide the ability for customers to add documents (files) with their metadata to particular folder.
- Supports adding revision to an existing document.
Input
This a multi-part request and all parameters should be listed before all file parts and should use the following order.
- projectnumber (String) Optional. Not required for company level.
- dorevise: (String) Optional. This flag is used to automatically revise file with same file name. Expected values are "yes" or "no". Default is no.
- data (JSON String) Required: List of field and values for the document attribute form.
- Path: Full path where the document will be created. The folder path must exists for the document to be created.
- Name: Name of the document that needs to be created.
Output
JSON object containing 'status', 'data', 'message'
Example
To create a document "ProjectDetails.doc" under "/Project Documents/Service docs" then data should as below
[
{"path":"/Service docs","fileName":"ProjectDetails.doc","docTitle":"project details","revNo":"1","issueDate":"06/01/2016", additional document attribute form properties, excluding creation date and owner }
]
Notes:
- Except for creation date and owner, you can add any additional document attribute form properties as key value pairs in the preceding JSON.
- This call only updates the elements visible in the upload window, such as Document Title, Revision No, and Issue Date. The system cannot update Custom Data Elements that are not listed in the upload window.
Example Multipart Form Request
Note: The form data body boundary in the example below is "—file upload—", but can be anything (or left unset).
-----file upload---
Content-Disposition: form-data; name="shortname"
unifier
-----file upload---
Content-Disposition: form-data; name="authcode"
MTIzMTIz
-----file upload---
Content-Disposition: form-data; name="dorevise"
yes
-----file upload---
Content-Disposition: form-data; name="projectnumber"
Shell-001
-----file upload---
Content-Disposition: form-data; name="data"
[
{"Path":"/Service docs","Name":"ProjectDetails.doc","docTitle":"project details","revNo":"1","issueDate":"06/01/2016", additional document attribute form properties, excluding creation date and owner }
]
-----file upload---
Content-Disposition: form-data; name="0"; filename="b.txt" Content-Type: text/plain
test document contents
-----file upload-----
Related Topics
Create Documents by Parent Folder ID
Update Documents Meta Data by Path
Update Document Meta Data by Document ID
Get Documents by Parent Folder ID
Last Published Tuesday, July 1, 2025