EEG-Workflow-System

API Documentation

Open Endpoints

Open endpoints require no Authentication.

• Login : POST /api/users/login/
• Register : POST /api/users/register/

Endpoints that require Authentication

Closed endpoints require a valid Token to be included in the header of the request. A Token can be acquired from the Login view above.

Current User related

Each endpoint manipulates or displays information related to the User whose Token is provided with the request:

• Get User Details : GET /api/user/details
• Reset Password : PUT /api/users/reset

Workflow related

Endpoints for performing Workflow related requests that the Authenticated User has permissions to access.

• Blocks Zip Upload : GET /api/workflow/upload
• Tree Initialization : POST /api/workflow/initialize
• Schedule Job - GET : GET /api/workflow/schedule
• Schedule Job - POST : POST /api/workflow/schedule
• Job Details : POST /api/workflow/jobs

This site is open source. Improve this page.