Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel

Table of Contents

...

Universal Controller supports the following RESTful-based web services for Simulation operations, which are listed alphabetically on this page.

Formatting specifications for each web service, including details about parameter requirements, are provided.

Anchor
create update
create update

...


 Description

URI

http://host_name/uc/resources/simulation

HTTP Method

Post/PUT

Description

Create Simulation.

Example URI

http://localhost:8080/uc/resources/simulation

Authentication

HTTP Basic

Produces Content-Type

application/xml, application/json

Consumes Content-Type

application/xml, application/json

Example RequestSee Create/Update a Simulation: Example Request.
Simulation PropertiesSee Simulation Properties and Simulation Output Properties, below. 

Example Responses

  • Status 200

    • Successfully created the simulation with id {uuid}.

  • Status 400

    • Error message.

  • Status 403

    • Operation prohibited due to security constraints.

  • Status 404

    • A simulation with taskname “{taskname}” does not exist.

    • A simulation with taskid "{uuid}" does not exist.

  • Status 500

    • Unexpected request failure. See log(s) for more details.

...


 Description

URI

http://host_name/uc/resources/simulation

HTTP Method

DELETE

Description

Delete Simulation.

URI ParametersSee Delete a Simulation: URI Parameters, below. 

Example URI

http://localhost:8080/uc/resources/simulation?taskname=task-1

http://localhost:8080/uc/resources/simulation?taskname=task-1&workflowname=work-1&vertexid=-1

http://localhost:8080/uc/resources/simulation?simulationid=12345

Authentication

HTTP Basic

Produces Content-Type

application/xml, application/json

Example Responses

Simulation deleted successfully.

...


 Description

URI

http://host_name/uc/resources/simulation/list

HTTP Method

GET

Description

List All Simulations.

Example URI

http://localhost:8080/uc/resources/simulation/list

http://localhost:8080/uc/resources/simulation/list?taskname=task-1

http://localhost:8080/uc/resources/simulation/list?workflowname=work-1

Authentication

HTTP Basic

Produces Content-Type

application/xml, application/json

Example Responses

See List Simulation: Example Response.

List Simulations: URI Parameters

...


 Description

URI

http://host_name/uc/resources/simulation

HTTP Method

GET

Description

read Simulation

Example URI

http://localhost:8080/uc/resources/simulation?taskname=task-1

http://localhost:8080/uc/resources/simulation?taskname=task-1&workflowname=work-1&vertexid=-1

http://localhost:8080/uc/resources/simulation?simulationid=12345

Authentication

HTTP Basic

Produces Content-Type

application/xml, application/json

Consumes Content-Type


Example Responses

See Read Simulation Response.

Read a Simulation: URI Parameters

...