Class Index

Classes


Directories

Shows the directory objects
Defined in: directories.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Directories(verbose, hierarchy, depth, paths, justChildren)
Displays managed directories in MediaBeacon.
Class Detail
Directories(verbose, hierarchy, depth, paths, justChildren)
Displays managed directories in MediaBeacon.
Parameters:
verbose Optional, Default: false
Setting this to true will collect a variety of default values for each asset.
hierarchy Optional, Default: false
Setting this to true will nest the directories in their parent directory object as a children array
depth Optional, Default: 0
The max depth of the children directories to fetch.
paths Optional
A directory path or an array of directory paths to collect.
justChildren Optional, Default: false
When set to true, a directory with a path in the paths parameter won't be included in the response, just its children.
Returns:
[{"name":"theDirectoryName", "path": "theDirectoryPath", "resolver": "directoryResolver, "assets":[anArrayOfAssetsInfo]}, ... ]
/wf/restapi/v2/directories

Parameters: none

 Response:
 [
	 {
	    "path": "/",
	    "id": 101,
	    "hasChildren": true
	  }
 ]
Verbose response
/wf/restapi/v2/directories

Parameters:
verbose=true
 [
	 {
	    "path": "/",
	    "id": 101,
	    "name": "Index",
	    "resolver": "directory://101",
	    "hasChildren": true
	  }
 ]
Increased Depth
/wf/restapi/v2/directories

Parameters:
depth=2
 [
	 {
	    "path": "/",
	    "id": 101
	  },
	 {
	    "path": "upload/",
	    "id": 139,
	    "parentId": 101
	  },
	 {
	    "path": "upload/root/",
	    "id": 140,
	    "parentId": 139,
	    "hasChildren": true
	  },
	 {
	    "path": "Videos/",
	    "id": 161,
	    "parentId": 101
	  }
 ]
Hierarchy enabled
/wf/restapi/v2/directories

Parameters:
depth=2
hierarchy=true
 [
	 {
	    "path": "/",
	    "id": 101,
	    "children": [
	      {
	        "path": "upload/",
	        "id": 139,
	        "parentId": 101,
	        "children": [
	          {
	            "path": "upload/root/",
	            "id": 140,
	            "parentId": 139,
	            "hasChildren": true
	          }
	        ]
	      },
	      {
	        "path": "Videos/",
	        "id": 161,
	        "parentId": 101,
	        "children": []
	      }
	    ]
	  }
 ]
Return specific directory by path
/wf/restapi/v2/directories

Parameters:
depth=2
hierarchy=true
paths=upload/
 [
	 {
	    "path": "upload/",
	    "id": 139,
	    "parentId": 101,
	    "children": [
	      {
	        "path": "upload/root/",
	        "id": 140,
	        "parentId": 139,
	        "children": [
	          {
	            "path": "upload/root/2018.11.06 11.37.49/",
	            "id": 141,
	            "parentId": 140
	          }
	        ]
	      }
	    ]
	  }
 ]
Return multiple specific directories by path
/wf/restapi/v2/directories

Parameters:
depth=2
hierarchy=true
paths=["upload/","Videos"]
 [
	 {
	    "path": "upload/",
	    "id": 139,
	    "parentId": 101,
	    "children": [
	      {
	        "path": "upload/root/",
	        "id": 140,
	        "parentId": 139,
	        "children": [
	          {
	            "path": "upload/root/2018.11.06 11.37.49/",
	            "id": 141,
	            "parentId": 140
	          }
	        ]
	      }
	    ]
	  },
	 {
	    "path": "Videos/",
	    "id": 161,
	    "parentId": 101,
	    "children": []
	 }
 ]
Fetch just the children directories
/wf/restapi/v2/directories

Parameters:
depth=2
hierarchy=true
paths=upload/
 [
	 {
	    "path": "upload/root/",
	    "id": 140,
	    "parentId": 139,
	    "children": [
	      {
	        "path": "upload/root/2018.11.06 11.37.49/",
	        "id": 141,
	        "parentId": 140
	      }
	    ]
	 }
 ]

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