Objective

It allows to create a new folder in the defined library. The properties of this folder are passed as a string parameter.

Parameters

ParameterDescriptionType
formThe name of the form used to create new folders.String
libraryeDOCS libraryString
userUser nameString
passwordUser passwordString
propertiesThis 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:

TestFolderadminFOLDER
adminTestFolderFOLDER

For a custom profile with custom fields:

ExampleFolderadminFOLDERadminExampleFolderFOLDER
CS36Consolis
NOT_APPLICABLE
CS3690AAAA0_SPAR0000-00

String
dbSchemaDatabase 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
clientOptional parameter for the client codeString
projectOptional parameter for the project codeString

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=TestFolder2adminDEFAULTDEFAULTFOLDERadminTestFolderFOLDER&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.