FolderServiceRest Resource

Folder (LMS)

Available Since
1.6.0

POST /2.0/lms/folder/create

This method has been deprecated. Use POST /lms/api/v0/folders/ instead.

Create a Folder

Available Since
1.6.0
Request Body
media type data type description
application/json FolderApiVO (JSON)
REQUIRED

Request JSON (example):


 {
 	"code" : "DSC1", // Code of Folder
 	"name" : "Folder name", // Name (required)
 	"parentId": 10, // Parent item that the folder will be created (required)
 	"inheritPermissions" : "INHERIT", // Type Inherit Permission "INHERIT" Or "NOT_INHERIT"
 	"securityPermission": [  // Defines the security configurations for the Folder
 		    {
 			  "partyId": 193, // Party ID
 			  "roles": [ "READ" ] // Permission level key. Acceptable values: NONE, READ, EXECUTE, WRITE, MODIFY, REMOVE, COMPLETE
 		  }
 	  ],
 	"securityRestriction": [  // Defines the security configurations for the Folder
 		    {
 			  "partyId": 193, // Party ID
 			  "roles": [ "MODIFY" ] // Restriction level key. Acceptable values: NONE, READ, EXECUTE, WRITE, MODIFY, REMOVE, COMPLETE
 		  }
 	  ]
 }
 
Response Body
media type data type description
application/json object (JSON)

 This method just return HTTP 200 status, Object FolderVO
{ content: { "id" : 1, "code" : "DSC1", "name" : "Folder name", "parentId": 10, "securityPermission": [ { "partyId": 193, "roles": [ "READ" ] } ], "securityRestriction": [ // Defines the security configurations for the Folder { "partyId": 193, // Party ID "roles": [ "MODIFY" ] // Restriction level key. Acceptable values: NONE, READ, EXECUTE, WRITE, MODIFY, REMOVE, COMPLETE } ], "inheritPermissions" : "INHERIT" // Type Inherit Permission "INHERIT" Or "NOT_INHERIT" }, message: { message: "OK", detail: "OK", type: "INFO" } }
Available Since
1.6.0

POST /2.0/lms/folder/edit

This method has been deprecated. Use PUT /lms/api/v0/folders/ instead.

Edit a Folder

Available Since
1.6.0
Request Body
media type data type description
application/json FolderApiVO (JSON)
REQUIRED

Request JSON (example):


 {
 	"id" : 1, // ID of Folder (required)
 	"code" : "DSC1", // Code of Folder (required)
 	"name" : "Folder name", // Name (required)
 	"parentId": 10, // Parent item that the folder will be created (required)
 	"inheritPermissions" : "INHERIT", // Type Inherit Permission "INHERIT" Or "NOT_INHERIT"
 	"securityPermission": [  // Defines the security configurations for the Folder
 		    {
 			  "partyId": 193, // Party ID
 			  "roles": [ "READ" ] // Permission level key. Acceptable values: NONE, READ, EXECUTE, WRITE, MODIFY, REMOVE, COMPLETE
 		  }
 	  ],
 	"securityRestriction": [  // Defines the security configurations for the Folder
 		    {
 			  "partyId": 193, // Party ID
 			  "roles": [ "MODIFY" ] // Restriction level key. Acceptable values: NONE, READ, EXECUTE, WRITE, MODIFY, REMOVE, COMPLETE
 		  }
 	  ]
 }
 
Response Body
media type data type description
application/json object (JSON)
This method just return HTTP 200 status, Object FolderVO
{ content: { "id" : 1, "code" : "DSC1", "name" : "Folder name", "parentId": 10, "securityPermission": [ { "partyId": 193, "roles": [ "READ" ] } ], "securityRestriction": [ { "partyId": 193, "roles": [ "MODIFY" ] } ], "inheritPermissions" : "INHERIT" }, message: { message: "OK", detail: "OK", type: "INFO" } }
Available Since
1.6.0

POST /2.0/lms/folder/delete/{folderId}

This method has been deprecated. Use DELETE /lms/api/v0/folders/{folderId} instead.

Delete a Folder

Available Since
1.6.0
Request Parameters
name type description constraints
folderId path ID folder to be removed long
Response Body
media type data type
application/json object (JSON)
Available Since
1.6.0

POST /2.0/lms/folder/move/{folderId}/{destinationId}

This method has been deprecated. Use POST /lms/api/v0/folders/move/{folderId}/{destinationId} instead.

Move a folder to another folder

Available Since
1.6.0
Request Parameters
name type description constraints
destinationId path destination folder ID long
folderId path ID folder to be moved long
Response Body
media type data type
application/json object (JSON)