Service

GET /session/{token}/result/{step}/{func}.help.json

GET /session/{token}/result/{step}/{func}.help.html

GET /session/{token}/result/.help.json

GET /session/{token}/result/.help.html

GET /api/spec/_/resource_list.json

GET /session/{token}/run.help.json

GET /session/{token}/run.help.html

GET /template/{type}.help.json

GET /template/{type}.help.html

GET /session/{token}.help.json

GET /session/{token}.help.html

GET /assets/{aid}.help.json

GET /assets/{aid}.help.html

GET /api/spec.json

GET /api/spec.html

GET /api/spec

GET /template.help.json

GET /template.help.html

GET /results.help.json

GET /results.help.html

GET /session.help.json

GET /session.help.html

GET /assets.help.json

GET /assets.help.html

GET /template

Returns a list of registered templates :return:

GET /results

GET /session

Starts a new session.

Calling this service allocates a new Hiflow3Session on the server side with a fresh working directory.

Request Headers:  

• Authorization –

Status Codes:

• 200 OK – no error

PUT /assets

Retrieve an asset, uploaded in the post data.

Returns:

the id for the resource on the server

Query Parameters:  

• url – an well-formed url

Status Codes:

• 200 OK – everything alright
• 400 Bad Request – everything exploded

POST /assets

Retrieve an asset form the given url.

Returns:

the id for the resource on the server

Query Parameters:  

• url – an well-formed url

Status Codes:

• 200 OK – everything alright
• 400 Bad Request – everything exploded

GET /api/spec/_/static/(string: dir1)/(string: dir2)/(string: dir3)

GET /api/spec/_/static/(string: dir1)/(string: dir2)

GET /session/(string: token)/result/(int: step)/(string: func)

GET /api/spec/_/static/(string: dir1)

GET /session/(string: token)/result/

GET /session/(string: token)/run

Start the simulation

GET /template/(string: type)

GET /session/(string: token)

Returns every information about current session state.

Query Parameters:  

• token – the authorization token

Status Codes:

• 200 OK – no error
• 405 Method Not Allowed – the token is invalid

PUT /session/(string: token)

Update the datasructure

Query Parameters:  

• token – the authorization token

Status Codes:

• 200 OK – no error
• 405 Method Not Allowed – the token is invalid

POST /session/(string: token)

Update hf3 and bc config.

Parameters:

• token –

Return:

DELETE /session/(string: token)

deallocate the server resources.

This call deletes the working directory and every in memory data.

Query Parameters:  

• token – the authorization token

Status Codes:

• 200 OK – no error
• 405 Method Not Allowed – the token is invalid

GET /assets/(string: aid)

Download given asset :param aid: :return:

DELETE /assets/(string: aid)