Folders

Folders

The /folder API provides access to details on the folders that flows are organised into.

/folder/:folder_id

http://localhost/jarvis-agent/n2int-angular/api/folder/

• GET Provides access to all folders the user is able to see, based on folder permission restrictions. A folder is included in the results if:
  • The folder has world read access.
  • The folder has group read access, and the user belongs to the group that owns the folder.
  • The folder has user read access, and the folder is owned by the authenticated user.
• POST Allows new folders to be created, subject to role restrictions. The user must have view.design.edit or view.organise.edit role access.
• PUT Allows existing folders to be updated, subject to role restrictions. The user must have view.design.edit or view.organise.edit role access, and the folder must match one of the following permissions:
  • The folder has world write access.
  • The folder has group write access, and the user belongs to the group that owns the folder.
  • The folder has user write access, and the folder is owned by the authenticated user.
• DELETE Allows the folder to be marked as deleted, subject to the same role restrictions as for PUT. Note that deleting a folder only marks the folder as deleted. The folder (and all stored flows, and their execution history) continue to exist in the database.