Class Index

Classes


Import

Imports files or folders
Defined in: import.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Import(data, updateType, verbose, fields)
Given the files/directories in "data" , this endpoint will import each into MediaBeacon
Class Detail
Import(data, updateType, verbose, fields)
Given the files/directories in "data" , this endpoint will import each into MediaBeacon
Parameters:
data
an array of file/directory paths or asset id's ["To/Import/file.txt",123456,"Directory/Import/" ...]
updateType Optional
string. Options are:
'ViewAndData' - previews and metadata potentially will be updated. Does not update on demand previews.
'Data' - metadata potentially will be updated.
'View' - previews potentially will be updated. Does not update on demand previews.
'ForceView' - the creation of a new preview request will be force regardless of the state of the cache and preview queue. On demand previews will be cleared.
verbose Optional, Default: false
Setting this to true will collect a variety of default values for each asset.
fields Optional
An array of field id's to collect the values for each asset
Returns:
[{assetInfo},{directoryInfo}, ... ]
/wf/restapi/v2/import

Parameters:
data=["To/Import/file.txt",123456,"Directory/Import/"]
updateType=ViewAndData
verbose=true

Response:
 [
	 {
	   "id": 201629348,
	   "name": "file.txt",
	   "path": "To/Import/file.txt",
	   "height": 0,
	   "width": 0,
	   "bytes": 0,
	   "lastModified": 1508164407000,
	   "mimeType": "text/plain",
	   "previews": {
		 "thumbnail": "../servlet/jb.view?table=thumbnails&col=thumbnails&id=pe_323031363239333438",
		 "viewex": "../servlet/jb.view?table=viewex&col=viewex&id=pe_323031363239333438",
		 "downloadUrl": "../servlet/dload?id=pe_323031363239333438"
	   }
	 },
	 {
	   "path": "Directory/Import/",
	   "name": "Import",
	   "resolver": "directory://161"
	 }
 ]

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Dec 15 2023 01:44:02 GMT-0600 (CST)