Class Index

Classes


Directories

Shows the directories and their assets
Defined in: directories.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Directories(verbose, FILTERS, fields)
Displays managed directories in MediaBeacon and their assets.
Class Detail
Directories(verbose, FILTERS, fields)
Displays managed directories in MediaBeacon and their assets.
Parameters:
verbose Optional, Default: false
Setting this to true will collect a variety of default values for each asset.
FILTERS Optional
Filtering can be applied to the "name", "path", and "resolver" properties if verbose=true.
fields Optional
An array of field id's to collect the values for each asset
Returns:
[{"name":"theDirectoryName", "path": "theDirectoryPath", "resolver": "directoryResolver, "assets":[anArrayOfAssetsInfo]}, ... ]
/wf/restapi/v2/directories

Parameters: none

 Response:
 [
    all Directories...
 ]
/wf/restapi/v2/directories

Parameters:
path=test/folder/

 Response:
 [
	 {
	    "name": "test",
	    "path": "test/folder/",
	    "resolver": "directory://182",
	    "assets": [
	      {
	        "id": 201628794
	      }
	    ]
	  }
 ]
/wf/restapi/v2/directories

Parameters:
path=test*

 Response:
 [
	 {
	    "name": "test2",
	    "path": "test/test2/",
	    "resolver": "directory://256",
	    "assets": []
	  },
	 {
	   "name": "test",
	   "path": "test/",
	   "resolver": "directory://179",
	   "assets": [
		 {
		   "id": 201629305
		 }
	   ]
	 }
 ]
/wf/restapi/v2/directories

Parameters:
name=test*
path=*2/

 Response:
 [
 {
	"name": "test2",
	"path": "test/test2/",
	"resolver": "directory://256",
	"assets": []
  },
 ]
/wf/restapi/v2/directories

Parameters:
name=test
verbose=true

 Response:
 [
	 {
	   "name": "test",
	   "path": "test/",
	   "resolver": "directory://179",
	   "assets": [
		 {
		   "id": 201629305,
		   "name": "testAsset.txt",
		   "path": "test/testAsset.txt",
		   "height": 0,
		   "width": 0,
		   "bytes": 0,
		   "lastModified": 1507839893000,
		   "mimeType": "text/plain",
		   "previews": {
			 "thumbnail": "../servlet/jb.view?table=thumbnails&col=thumbnails&id=pe_323031363239333035",
			 "viewex": "../servlet/jb.view?table=viewex&col=viewex&id=pe_323031363239333035",
			 "downloadUrl": "../servlet/dload?id=201629305"
		   }
		 }
	   ]
	 }
 ]

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 06 2018 16:08:51 GMT-0500 (CDT)