OpenMeetings API Methods

importFile

Method: importFile ( String SID , String externalUserId , Long externalFileId , String externalType , Long room_id , boolean isOwner , String path , Long parentFolderId , String fileSystemName )

Import file from external source to upload a file to a room-drive you specify: externalUserId, user if of openmeetings user for which we upload the file room_id = openmeetings room id isOwner = 0 parentFolderId = 0 to upload a file to a private-drive you specify: externalUserId, user if of openmeetings user for which we upload the file room_id = openmeetings room id isOwner = 1 parentFolderId = -2

Return Type: org.openmeetings.axis.services.FileImportError[]

Params:

Type	Fieldname	Description
String	SID	The logged in session id with minimum webservice level
String	externalUserId	the external user id => If the file should goto a private section of any user, this number needs to be set
Long	externalFileId	the external file-type to identify the file later
String	externalType	the name of the external system
Long	room_id	the room Id, if the file goes to the private folder of an user, you can set a random number here
boolean	isOwner	specify a 1/true AND parentFolderId==-2 to make the file goto the private section
String	path	http-path where we can grab the file from, the file has to be accessible from the OpenMeetings server
Long	parentFolderId	specify a parentFolderId==-2 AND isOwner == 1/true AND to make the file goto the private section
String	fileSystemName	the filename => Important WITH file extension!

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/FileService/importFile?SID=VALUE&externalUserId=VALUE&externalFileId=VALUE&externalType=VALUE&room_id=VALUE&isOwner=VALUE&path=VALUE&parentFolderId=VALUE&fileSystemName=VALUE

importFileByInternalUserId

Method: importFileByInternalUserId ( String SID , Long internalUserId , Long externalFileId , String externalType , Long room_id , boolean isOwner , String path , Long parentFolderId , String fileSystemName )

Import file from external source to upload a file to a room-drive you specify: internalUserId, user if of openmeetings user for which we upload the file room_id = openmeetings room id isOwner = 0 parentFolderId = 0 to upload a file to a private-drive you specify: internalUserId, user if of openmeetings user for which we upload the file room_id = openmeetings room id isOwner = 1 parentFolderId = -2

Return Type: org.openmeetings.axis.services.FileImportError[]

Params:

Type	Fieldname	Description
String	SID	The SID of the User. This SID must be marked as logged in
Long	internalUserId	the openmeetings user id => If the file should goto a private section of any user, this number needs to be se
Long	externalFileId	the external file-type to identify the file later
String	externalType	the name of the external system
Long	room_id	the room Id, if the file goes to the private folder of an user, you can set a random number here
boolean	isOwner	specify a 1/true AND parentFolderId==-2 to make the file goto the private section
String	path	http-path where we can grab the file from, the file has to be accessible from the OpenMeetings server
Long	parentFolderId	specify a parentFolderId==-2 AND isOwner == 1/true AND to make the file goto the private section
String	fileSystemName	the filename => Important WITH file extension!

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/FileService/importFileByInternalUserId?SID=VALUE&internalUserId=VALUE&externalFileId=VALUE&externalType=VALUE&room_id=VALUE&isOwner=VALUE&path=VALUE&parentFolderId=VALUE&fileSystemName=VALUE

addFolderByExternalUserIdAndType

Method: addFolderByExternalUserIdAndType ( String SID , String externalUserId , Long parentFileExplorerItemId , String folderName , Long room_id , Boolean isOwner , Long externalFilesid , String externalType )

to add a folder to the private drive, set parentFileExplorerItemId = 0 and isOwner to 1/true and externalUserId/externalUserType to a valid user

Return Type: java.lang.Long

Params:

Type	Fieldname	Description
String	SID	The SID of the User. This SID must be marked as logged in
String	externalUserId	the external file-type to identify the file later
Long	parentFileExplorerItemId
String	folderName	the name of the folder
Long	room_id	the room Id, if the file goes to the private folder of an user, you can set a random number here
Boolean	isOwner	specify a 1/true AND parentFolderId==-2 to make the file goto the private section
Long	externalFilesid	the external file-type to identify the file later
String	externalType	the name of the external system

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/FileService/addFolderByExternalUserIdAndType?SID=VALUE&externalUserId=VALUE&parentFileExplorerItemId=VALUE&folderName=VALUE&room_id=VALUE&isOwner=VALUE&externalFilesid=VALUE&externalType=VALUE

addFolderByUserId

Method: addFolderByUserId ( String SID , Long userId , Long parentFileExplorerItemId , String folderName , Long room_id , Boolean isOwner , Long externalFilesid , String externalType )

to add a folder to the private drive, set parentFileExplorerItemId = 0 and isOwner to 1/true and userId to a valid user

Return Type: java.lang.Long

Params:

Type	Fieldname	Description
String	SID	The SID of the User. This SID must be marked as logged in
Long	userId	the openmeetings user id
Long	parentFileExplorerItemId	specify a parentFolderId==-2 AND isOwner == 1/true AND to make the file goto the private section
String	folderName	the name of the folder
Long	room_id	the room Id, if the file goes to the private folder of an user, you can set a random number here
Boolean	isOwner	specify a 1/true AND parentFolderId==-2 to make the file goto the private section
Long	externalFilesid	the external file-type to identify the file later
String	externalType	the name of the external system

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/FileService/addFolderByUserId?SID=VALUE&userId=VALUE&parentFileExplorerItemId=VALUE&folderName=VALUE&room_id=VALUE&isOwner=VALUE&externalFilesid=VALUE&externalType=VALUE

addFolderSelf

Method: addFolderSelf ( String SID , Long parentFileExplorerItemId , String fileName , Long room_id , Boolean isOwner )

Add a folder by the current user - similar to RTMP Call

Return Type: java.lang.Long

Params:

Type	Fieldname	Description
String	SID	The SID of the User. This SID must be marked as logged in
Long	parentFileExplorerItemId	parent folder id
String	fileName	the file name
Long	room_id	the room id
Boolean	isOwner

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/FileService/addFolderSelf?SID=VALUE&parentFileExplorerItemId=VALUE&fileName=VALUE&room_id=VALUE&isOwner=VALUE

deleteFileOrFolderByExternalIdAndType

Method: deleteFileOrFolderByExternalIdAndType ( String SID , Long externalFilesid , String externalType )

deletes a file by its external Id and type

Return Type: java.lang.Long

Params:

Type	Fieldname	Description
String	SID	The SID of the User. This SID must be marked as logged in
Long	externalFilesid	the od of the file or folder
String	externalType	the externalType

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/FileService/deleteFileOrFolderByExternalIdAndType?SID=VALUE&externalFilesid=VALUE&externalType=VALUE

deleteFileOrFolder

Method: deleteFileOrFolder ( String SID , Long fileExplorerItemId )

deletes files or folders based on it id

Return Type: java.lang.Long

Params:

Type	Fieldname	Description
String	SID	The SID of the User. This SID must be marked as logged in
Long	fileExplorerItemId	the id of the file or folder

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/FileService/deleteFileOrFolder?SID=VALUE&fileExplorerItemId=VALUE

deleteFileOrFolderSelf

Method: deleteFileOrFolderSelf ( String SID , Long fileExplorerItemId )

deletes files or folders based on it id

Return Type: java.lang.Long

Params:

Type	Fieldname	Description
String	SID	The SID of the User. This SID must be marked as logged in
Long	fileExplorerItemId	the id of the file or folder

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/FileService/deleteFileOrFolderSelf?SID=VALUE&fileExplorerItemId=VALUE

getImportFileExtensions

Method: getImportFileExtensions ( )

Get available import File Extension allowed during import

Return Type: java.lang.String[]

Params:

No Params
REST Sample Call/URL:
http://localhost:5080/openmeetings/services/FileService/getImportFileExtensions

getPresentationPreviewFileExplorer

Method: getPresentationPreviewFileExplorer ( String SID , String parentFolder )

Get a LibraryPresentation-Object for a certain file

Return Type: org.openmeetings.app.data.file.dto.LibraryPresentation

Params:

Type	Fieldname	Description
String	SID
String	parentFolder

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/FileService/getPresentationPreviewFileExplorer?SID=VALUE&parentFolder=VALUE

getFileExplorerByRoom

Method: getFileExplorerByRoom ( String SID , Long room_id , Long owner_id )

Get a File Explorer Object by a given Room and owner id

Return Type: org.openmeetings.app.data.file.dto.FileExplorerObject

Params:

Type	Fieldname	Description
String	SID	The SID of the User. This SID must be marked as logged in
Long	room_id	Room id
Long	owner_id	Owner id

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/FileService/getFileExplorerByRoom?SID=VALUE&room_id=VALUE&owner_id=VALUE

getFileExplorerByRoomSelf

Method: getFileExplorerByRoomSelf ( String SID , Long room_id )

Get a File Explorer Object by a given Room

Return Type: org.openmeetings.app.data.file.dto.FileExplorerObject

Params:

Type	Fieldname	Description
String	SID	The SID of the User. This SID must be marked as logged in
Long	room_id	Room Id

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/FileService/getFileExplorerByRoomSelf?SID=VALUE&room_id=VALUE

getFileExplorerByParent

Method: getFileExplorerByParent ( String SID , Long parentFileExplorerItemId , Long room_id , Boolean isOwner , Long owner_id )

Get FileExplorerItem list by parent folder

Return Type: org.openmeetings.app.persistence.beans.files.FileExplorerItem[]

Params:

Type	Fieldname	Description
String	SID	The SID of the User. This SID must be marked as logged in
Long	parentFileExplorerItemId	the parent folder id
Long	room_id	the room id
Boolean	isOwner	true if its a private drive
Long	owner_id	the owner id

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/FileService/getFileExplorerByParent?SID=VALUE&parentFileExplorerItemId=VALUE&room_id=VALUE&isOwner=VALUE&owner_id=VALUE

getFileExplorerByParentSelf

Method: getFileExplorerByParentSelf ( String SID , Long parentFileExplorerItemId , Long room_id , Boolean isOwner )

Get FileExplorerItem[] by parent and owner id

Return Type: org.openmeetings.app.persistence.beans.files.FileExplorerItem[]

Params:

Type	Fieldname	Description
String	SID	SID The SID of the User. This SID must be marked as logged in
Long	parentFileExplorerItemId	the parent folder id
Long	room_id	the room id
Boolean	isOwner	true to request private drive

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/FileService/getFileExplorerByParentSelf?SID=VALUE&parentFileExplorerItemId=VALUE&room_id=VALUE&isOwner=VALUE

updateFileOrFolderName

Method: updateFileOrFolderName ( String SID , Long fileExplorerItemId , String fileName )

update a file or folder name

Return Type: java.lang.Long

Params:

Type	Fieldname	Description
String	SID	SID The SID of the User. This SID must be marked as logged in
Long	fileExplorerItemId	file or folder id
String	fileName	new file or folder name

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/FileService/updateFileOrFolderName?SID=VALUE&fileExplorerItemId=VALUE&fileName=VALUE

updateFileOrFolderNameSelf

Method: updateFileOrFolderNameSelf ( String SID , Long fileExplorerItemId , String fileName )

update a file or folder name

Return Type: java.lang.Long

Params:

Type	Fieldname	Description
String	SID	SID The SID of the User. This SID must be marked as logged in
Long	fileExplorerItemId	file or folder id
String	fileName	new file or folder name

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/FileService/updateFileOrFolderNameSelf?SID=VALUE&fileExplorerItemId=VALUE&fileName=VALUE

moveFile

Method: moveFile ( String SID , Long fileExplorerItemId , Long newParentFileExplorerItemId , Long room_id , Boolean isOwner , Boolean moveToHome , Long owner_id )

move a file or folder

Return Type: java.lang.Long

Params:

Type	Fieldname	Description
String	SID	SID The SID of the User. This SID must be marked as logged in
Long	fileExplorerItemId	current file or folder id to be moved
Long	newParentFileExplorerItemId	new parent folder id
Long	room_id	room id
Boolean	isOwner	if true owner id will be set
Boolean	moveToHome	if true move to private drive
Long	owner_id	owner id

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/FileService/moveFile?SID=VALUE&fileExplorerItemId=VALUE&newParentFileExplorerItemId=VALUE&room_id=VALUE&isOwner=VALUE&moveToHome=VALUE&owner_id=VALUE

moveFileSelf

Method: moveFileSelf ( String SID , Long fileExplorerItemId , Long newParentFileExplorerItemId , Long room_id , Boolean isOwner , Boolean moveToHome )

move a file or folder

Return Type: java.lang.Long

Params:

Type	Fieldname	Description
String	SID	SID The SID of the User. This SID must be marked as logged in
Long	fileExplorerItemId	current file or folder id to be moved
Long	newParentFileExplorerItemId	new parent folder id
Long	room_id	room id
Boolean	isOwner	if true owner id will be set
Boolean	moveToHome	move to private drive

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/FileService/moveFileSelf?SID=VALUE&fileExplorerItemId=VALUE&newParentFileExplorerItemId=VALUE&room_id=VALUE&isOwner=VALUE&moveToHome=VALUE

Available WebServices:

WebService: FileService

Index of Methods available in FileService

Methods Details in FileService