Returns the sub-networks that are available for micro simulations and can be used as parameters for requests to → Requesting a micro simulation or micro simulation group.
Authentication phase
Before using the endpoint, you must run the authentication phase (→ Login).
After the authentication, a session opens and a valid session token persists until:
- The end of the session time-out, that is set through the parameter sessionTimeout (→ OptimaWSI configuration > OptimaAuth section).
- An explicit Logout call (→ Logout).
Request Endpoint
Request
GET
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optimissim/subnetwork/{SubnetworkId}
The path parameter SubnetworkId is optional. If it is not specified, information for all subnetworks is returned.
Request parameters
Not applicable.
Request content-type
Not applicable.
Request entity
Not applicable.
Response
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
Result of the processed request. The request has success if SubnetworkId is valid. |
|
401 Unauthorized |
The requested resource is restricted and requires authentication. Please see → Login (deprecated). |
|
404 Not Found |
If :the simulation for the specified SubnetworkId is not found, the service answers with a specific message hosted in the entity. |
For the complete list of error codes and messages, see → Optima Micro: error codes and response status > Error codes of the Optima Micro API.
Response content-type
application/json
Request body (payload)
JSON message with information describing the subnetworks.
Example
Request
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optimissim/subnetwork/
Response status
200
Response output
{
"subnetworks": [
{
"subnetId": 2,
"name": null,
"description": null
},
{
"subnetId": 42,
"name": null,
"description": null
}
]
}