restapi-endpoints.md

REST API Endpoints

This section provides a detailed list of avaliable endpoints in Visualizer REST API.

Start visualization

Start the visualization of a running application.

• URL: /visualizing

• Method: POST

• JSON Request:

  • {
       username : [string],
       password : [string],
       plugin: [string],
       plugin_info : {
           ...
       }
    }

• Success Response:

  • Code: 202
    Content:

    • {
         job_id : [string]
      }

• Error Response:

  • Code: 400 BAD REQUEST and 401 UNAUTHORIZED
    

Stop visualization

Stop the visualization of a running application.

• URL: /visualizing/:id/stop

• Method: PUT

• JSON Request:

  • {
       username : [string],
       password : [string]
    }

• Success Response:

  • Code: 204
    

• Error Response:

  • Code: 400 BAD REQUEST and 401 UNAUTHORIZED
    

Get visualization URL

Returns the url of the visualizer of the job.

• URL: /visualizing/:id
• Method: GET
• Success Response:
  • Code: 200
    Content:

    • {
         url : [string]		 
      }