REST API interface

HEAD /simulators/pydss/instances

Returns UUIDs of all the instances currently running on the server

Status Codes:

• 200 OK – UUIDs of all currently running pydss instances have been returned

• 204 No Content – No active pydss instance found

GET /simulators/pydss/instances

Returns UUIDs of all the instances currently running on the server

Status Codes:

• 200 OK – UUIDs of all currently running pydss instances have been returned

• 204 No Content – No active pydss instance found

HEAD /simulators/pydss/status/uuid/{uuid}

Returns states of process of with UUID matching the passed UUID

Parameters:

• uuid (string)

Status Codes:

• 200 OK – pydss instance with the provided UUID is currently running

• 204 No Content – pydss instance with the provided UUID does not exist

GET /simulators/pydss/status/uuid/{uuid}

Returns states of process of with UUID matching the passed UUID

Parameters:

• uuid (string)

Status Codes:

• 200 OK – pydss instance with the provided UUID is currently running

• 204 No Content – pydss instance with the provided UUID does not exist

HEAD /simulators/pydss/info

Returns a dictionary of valid project and scenarios in the provided path

Query Parameters:

• path (string) – (Required)

Status Codes:

• 200 OK – Successfully retrieved project information

• 406 Not Acceptable – Provided path does not exist

GET /simulators/pydss/info

Returns a dictionary of valid project and scenarios in the provided path

Query Parameters:

• path (string) – (Required)

Status Codes:

• 200 OK – Successfully retrieved project information

• 406 Not Acceptable – Provided path does not exist

PUT /simulators/pydss

Run a command on an active instance of pydss

Status Codes:

• 200 OK – Successfully retrieved project information

• 401 Unauthorized – Provided path does not exist

• 403 Forbidden – Provided path does not exist

POST /simulators/pydss

Creates an instance of pydss and runs the simulation

Status Codes:

• 200 OK – Successfully retrieved project information

• 500 Internal Server Error – Provided path does not exist

DELETE /simulators/pydss

Deletes an active instance of pydss

Parameters:

• uuid (string)

Status Codes:

• 200 OK – Successfully retrieved project information

• 403 Forbidden – Provided path does not exist

POST /simulators/pydss/create

Creates a new project for pydss (User uploads a zipped OpenDSS model)

Status Codes:

• 200 OK – Successfully retrieved project information

• 403 Forbidden – Provided path does not exist