API docs by Redocly

Bloonet Web Services API

Download OpenAPI specification:

Siradel: software-support@siradel.com URL: https://www.siradel.com License: Proprietary

The Bloonet Web Services API enables users to model and test radio propagation for any radio, anywhere. Authenticate by passing your Oauth2 credentials in the request header as Authorization. Contact Siradel support (software-support@siradel.com) to request the creation of a new account in order to receive your login details.

Simulation API access through Saas access includes access to 3D map.

Antenna

This resource describes an antenna and its diagram file in xml, txt or msi format.

You can post to your environment Siradel Web Services your own antenna, and use it for your simulations.

Get antennas

Get the antenna list

query Parameters
permission
string
Default: "ALL"
Enum: "ALL" "PUBLIC" "OWNED" "PUBLIC_OWNED"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create antenna

Add an antenna to the database, using embedded antenna diagram file

Request Body schema: multipart/form-data
required
object (Antenna)

Antenna to create as json

data
required
string <binary>

Antenna file

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "fileContent": "string",
  • "advancedMergedMode": true,
  • "msiPositive": true,
  • "creationDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Create gob

Add a gob to the database, using embedded gob diagram file

Request Body schema: application/json
required
uuid
string <uuid>
name
required
string [ 0 .. 100 ] characters
type
required
string
Enum: "CSI" "SSB"
frequencyMin
number
frequencyMax
number
description
string
required
Array of objects (Beam) non-empty

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "type": "CSI",
  • "frequencyMin": 0,
  • "frequencyMax": 0,
  • "description": "string",
  • "beams": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "fileContent": "string",
  • "advancedMergedMode": true,
  • "msiPositive": true,
  • "creationDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "type": "CSI",
  • "frequencyMin": 0,
  • "frequencyMax": 0,
  • "description": "string",
  • "beams": [
    ]
}

Create antenna beams

Add a list of beams to the database

Request Body schema: multipart/form-data
required
Array of objects (Antenna)

Beams to create as json

data
required
Array of strings <binary> [ items <binary > ]

Beams files

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get antennas

Get antenna by its uuid

path Parameters
uuid
required
string <uuid>

the antenna uuid

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "fileContent": "string",
  • "advancedMergedMode": true,
  • "msiPositive": true,
  • "creationDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Delete antenna

Delete an antenna by its uuid

path Parameters
uuid
required
string <uuid>

the antenna uuid

Responses

Get antennas by name

Get antennas by name

path Parameters
name
required
string

the name of the antenna

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Session

A session includes the elements necessary for a calculation (propagation models, base stations, user equipment, prediction groups, predictions, post processings).

Get sessions

Get all the sessions

query Parameters
numberLimit
integer <int32> > 0

Number of object returned

sort
string
Enum: "ASCENDING" "DESCENDING"

Sorting order

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create session

Create session

Request Body schema: application/json
required
uuid
string <uuid>
name
required
string [ 0 .. 100 ] characters
description
required
string [ 0 .. 100 ] characters
date
string <date-time>
sridEpsg
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "description": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "sridEpsg": 0
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "description": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "sridEpsg": 0
}

Get session

Get the by session uuid

path Parameters
uuid
required
string <uuid>

the session uuid

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "description": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "sridEpsg": 0,
  • "userEquipmentUuids": [
    ],
  • "baseStationUuids": [
    ],
  • "modelUuids": [
    ]
}

Delete session

Delete the session by uuid

path Parameters
uuid
required
string <uuid>

the session uuid

Responses

Get session info

Get session information by uuid

path Parameters
uuid
required
string <uuid>

the session uuid

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "description": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "sridEpsg": 0
}

ping

Responses

Response samples

Content type
application/json
{
  • "response": "string",
  • "application": {
    },
  • "config-env": "string",
  • "volcanoweb-configuration": {
    },
  • "volcano-version": "string",
  • "systema-version": "string",
  • "optimus-acp-version": "string",
  • "systema-configuration": {
    },
  • "startup-scripts": [
    ]
}

ping

Responses

Response samples

Content type
application/json
{
  • "response": "string",
  • "application": {
    },
  • "config-env": "string",
  • "volcanoweb-configuration": {
    },
  • "volcano-version": "string",
  • "systema-version": "string",
  • "optimus-acp-version": "string",
  • "systema-configuration": {
    },
  • "startup-scripts": [
    ]
}

Map data

A map data is a geographic dataset containing spatial information (such as terrain, buildings, or environment) used as input for simulations.

Create mapdata

Add mapdata to the database

Request Body schema: application/json
required
uuid
string <uuid>
name
required
string [ 0 .. 100 ] characters
Array of objects (Layer) unique
sridEpsg
required
integer <int32>
type
string
Value: "3DTWorld"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "layers": [
    ],
  • "sridEpsg": 0,
  • "type": "3DTWorld"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "layers": [
    ],
  • "sridEpsg": 0,
  • "type": "3DTWorld"
}

Get mapdata

Get the mapdata by its uuid

path Parameters
uuid
required
string <uuid>

the mapdata uuid

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "layers": [
    ],
  • "sridEpsg": 0,
  • "type": "3DTWorld"
}

Delete mapdata

Delete mapdata by its uuid

path Parameters
uuid
required
string <uuid>

the mapdata uuid

Responses

Quota

A quota defines usage limits applied to users or entities, controlling consumption of system capabilities.

Get user quota

Get list of user quota

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Result

A result represents an output of a propagation calculation. It can be downloaded.

Get results

Get list of results by uuids

query Parameters
uuids
any

the result uuids

Request Body schema: application/json
required
Array
string <uuid>

Responses

Request samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type
application/json
[
  • {
    }
]

Filter results by area

Filter results by area

Request Body schema: application/json
required
required
object (BoundingBox)
ResultUuids
required
Array of strings <uuid> [ items <uuid > ]
epsgCode
required
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "bbox": {
    },
  • "ResultUuids": [
    ],
  • "epsgCode": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Get results

Get all results

query Parameters
lastUsedBefore
string <date-time>
Example: lastUsedBefore=Format yyyy-MM-ddTHH:mm:ss or yyyy-MM-dd

Filtering results last used before specified date

lastUsedAfter
string <date-time>
Example: lastUsedAfter=Format yyyy-MM-ddTHH:mm:ss or yyyy-MM-dd

Filtering results last used after specified date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get result

Get a result by its uuid

path Parameters
uuid
required
string <uuid>

the result uuid

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "lastUseDate": "2019-08-24T14:15:22Z",
  • "title": "string",
  • "type": "string",
  • "resolution": 0.1,
  • "unit": "string",
  • "epsgCode": 0,
  • "rxHeight": 0.1,
  • "bbox": {
    },
  • "fileName": "string"
}

Delete result

Delete a result by its uuid

path Parameters
uuid
required
string <uuid>

the result uuid

Responses

Download result file

Download result file by its uuid

path Parameters
uuid
required
string <uuid>

the file uuid

Responses

Download result file on KMZ format

Download KMZ result file by its uuid

path Parameters
uuid
required
string <uuid>

The file uuid

palette
required
string

Name of the palette to use

Responses

Download result file on KMZ format

Download KMZ result file by its uuid

path Parameters
uuid
required
string <uuid>

The file uuid

palette
required
string

Name of the palette to use

min
required
number <double>

Minimum value for the palette

max
required
number <double>

Maximum value for the palette

Responses

Simulation

A simulation enable to run, within a session, simulation with parameters defined in a json object.

Json object in input must defines :

  • uuid
  • name
  • session uuid
  • propagation request : base station informations, user equipement information
  • post processing : simulation resolution, result type, ...

A sample object is described below.

A shapefile can be added, if you want to use a computation zone.

Cancel simulation

Cancel simulation by uuid

path Parameters
uuid
required
string <uuid>

The simulation uuid

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "description": "string",
  • "calculationSessionUuid": "85cd0094-594c-4cd7-ae95-1242f83e6a76",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "status": {
    },
  • "steps": [
    ]
}

Get simulations

Get all simulations

query Parameters
permission
string
Default: "ALL"
Enum: "ALL" "PUBLIC" "OWNED" "PUBLIC_OWNED"
state
string
Enum: "WAITING" "RUNNING" "RUNNING_WITH_ERROR" "CANCELED" "ABORTED" "DONE" "DONE_WITH_ERROR" "ERROR"
required
object (PaginatedRequest)

Class that can be used to manage paginated requests. It can be used as a parameter in a spring Controller method, and the endpoint will be able to receive parameters that match the names used in the {@link ConstructorProperties ConstructorProperties} annotation used on {@link PaginatedRequest#PaginatedRequest(Integer, Integer, PagingAndSortingConstant.Sorting[], String[], String, List) PaginatedRequest#PaginatedRequest(Integer, Integer, PagingAndSortingConstant.Sorting[], String[], String, List)}
This class needs getters and setters on all its properties otherwise they are not detected by the typescript generator plugin

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total_items": 0,
  • "current_page": 0,
  • "items_per_page": 0,
  • "total_pages": 0
}

Create simulation

Create simulation

Request Body schema: multipart/form-data
required
object (SimulationRequest)

The simulation

shapefileArchive
string <binary>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "description": "string",
  • "calculationSessionUuid": "85cd0094-594c-4cd7-ae95-1242f83e6a76",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "status": {
    },
  • "steps": [
    ]
}

Get simulation

Get simulation by uuid

path Parameters
uuid
required
string <uuid>

the simulation uuid

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "description": "string",
  • "calculationSessionUuid": "85cd0094-594c-4cd7-ae95-1242f83e6a76",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "status": {
    },
  • "steps": [
    ]
}

Delete simulation

Delete simulation by uuid

path Parameters
uuid
required
string <uuid>

The simulation uuid

Responses

Get simulation status

Get simulation status

path Parameters
uuid
required
string <uuid>

The simulation uuid

Responses

Response samples

Content type
application/json
{
  • "progress": 0.1,
  • "log": "string",
  • "error": "string",
  • "errorMessages": [
    ],
  • "state": "WAITING"
}

Get simulation results

Get simulation results

path Parameters
uuid
required
string <uuid>

The simulation uuid

query Parameters
rx_height
number <double>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get propagation results by simulation uuid

Get propagation results by simulation uuid

path Parameters
uuid
required
string <uuid>

The simulation uuid

Responses

Propagation model

A propagation model is a mathematical representation used to predict how radio waves travel through an environment, accounting for factors like distance, obstacles, and terrain.

Get propagation models

Get propagation models by session uuid

query Parameters
sessionid
string <uuid>

the model session's uuid

permission
string
Default: "ALL"
Enum: "ALL" "PUBLIC" "OWNED" "PUBLIC_OWNED"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete propagation models

Delete the propagation model by sessions uuid

query Parameters
sessionid
required
string <uuid>

the model session uuid

Responses

Get propagation model

Get the propagation model by uuid

path Parameters
uuid
required
string <uuid>

the model uuid

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "description": "string",
  • "sessionUuid": "0688aee8-ffa9-4d26-9262-47526493535e",
  • "fileContent": "string",
  • "mapdataUuid": "fc8cd759-03e0-4ba7-a459-ede1510eefbb",
  • "facadeIncidenceAngleContent": "string",
  • "type": "3DTWorld",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Delete propagation model

Delete the propagation model by uuid

path Parameters
uuid
required
string <uuid>

the model uuid

Responses