Objective
It allows to create a new folder in the defined library. The properties of this folder are passed as a string parameter.
Parameters
Parameter | Description | Type |
form | The name of the form used to create new folders. | String |
library | eDOCS library | String |
user | User name | String |
password | User password | String |
properties | This parameter represents all the properties that must be provided to create a folder on the library and they are defined on the profile. APP_ID property should be “FOLDER”. Properties must be passed as a string. Properties have to be in this format: Valid for DEF_PROF:
For a custom profile with custom fields:
| String |
dbSchema | Database schema. By default is set to “DOCSADM” if an empty string is passed. Note: by default the new folder is created with security with Full Access to the TYPIST_ID value. | String |
client | Optional parameter for the client code | String |
project | Optional parameter for the project code | String |
Rest Invoke
- http://localhost:port/GSService/xml/ or http://localhost:port/GSService/json/
- UriTemplate:
- “/CreateFolder/?form={form}/?library={library}&user={user}&password={password}&properties={properties}&dbSchema={dbSchema}&client={client}&project={project}”
- “/CreateFolderDST/?form={form}/?library={library}&user={user}&dst={dst}&properties={properties}&dbSchema={dbSchema}&client={client}&project={project}”
Example
http://localhost:8732/GSService/xml/CreateFolder/?form=LAWPROF/?library= DMTESTLEGAL&user=admin&password=owc123&properties=TestFolder2 admin DEFAULT DEFAULT FOLDER admin TestFolder FOLDER &dbSchema=DOCSADM
The method returns the new folder ID if the operation was successful or the error string if the operation fails.
DST Example
http://localhost:8732/GSService/xml/CreateFolderDST/?form=LAWPROF/library=DMTESTLEGAL&user=admin&dst=afd448a5d0f9b...55355b8c677ad16&properties=TestFolder2adminUTHOR_ID>DEFAULTDEFAULTFOLDERadminTYPIST_ID>TestFolderFOLDER&dbSchema=DOCSADM
Error
Check the event.log file if you find errors.