Create a new Node
The Nid of the parent Node under which to create the new Node
The name of the new Node
Whether this new Node should be a folder or not
The type of files that will be stored in this Node, for a folder node use FOLDER
The Nid of the newly created Node
Create a new Node, but only if it did not already exist
The Nid of the parent Node under which to create the new Node
The name of the new Node
Whether this new Node should be a folder or not
The type of files that will be stored in this Node, for a folder node use FOLDER
The Nid of the newly created Node, of if the Node already existed the Nid of the existing Node
Delete a Node by it's Nid. Will throw an exception if the Node does not exist or was already deleted.
The UUID of the Node to delete
Delete a NodeError by it's id
The UUID of the Node
The UUID of the Error
Will delete the designated Node if is has not already been deleted. Will not throw an exception when there is no such Node.
The UUID of the Node to delete
Delete a Version. In a future version, the requirement to specify the nodeUuid in this method will be dropped
The UUID of the Node
The UUID of the Version
Get a Node by a given Vid. This can be useful if you want to quickly go from a known Vid o Node without first resolving the Version object.
Resolve the given Vid to a Version
The UUID of the Version to fetch
Resolve the given Vids to an array of Version
Get the Root node of the current authorization context
Get the Nid of the root Node of the current authorization context
List all the known Error on the given Node
List all the direct child Nodes of the given Nid.
List all the child nodes of the Node on the given path
Recursively list all the child Nodes of the given Nid. The Promise will resolve to a flat array of all the nodes.
List all the known Version on the given Node
The path to the Node
Whether a Node already exists on the given path
Rename an existing Node
The UUID of the Node
The new name of the Node
Undelete a given Node. Undeleting Nodes is currently only allowed for users with SUPER_ADMIN rights
The UUID of the Node to undelete
API Namespace Fs is used for BIM.works FileSystem related API calls.
A note about "paths" in BIM.works: Paths are relative to your credentials. For example an API Token that has been created on "/My Organization/Sub Folder" will resolve "/" to "/My Organization/Sub Folder"