Simulator [CH - QA]
Modify the object in Simulations collection
Modify an object present in Simulations collection
patch
Path Parameters
simulationIdstringrequired
Resource ID in UUID format
Body
application/vnd.api+json
Body
application/vnd.api+json
Simulation
SimulationJsonApiType
Object in JSON:API format.
dataobjectrequired
Data structure for all operations.
Show Child Parameters
Response
application/vnd.api+json
Response
application/vnd.api+json
Ok
SimulationJsonApiType
Object in JSON:API format.
dataobjectrequired
Data structure for all operations.
Show Child Parameters
patch/simulations/{simulationId}
Path Parameters
Body
{
"data": {
"attributes": {
"date": "2023-09-15",
"name": "Simulation-1",
"simulationType": "GUARANTEE",
"calculationType": "MODEL",
"algorithmType": "IM"
},
"id": "95b1b467-bd69-4436-8181-96c16408c230",
"type": "simulation"
}
}
application/vnd.api+json
Calculations
Calculations management endpoints
Retrieves the collection of Calculations
Retrieves the collection of Calculations. This collection is paginated.
get
Query Parameters
page[size]integer
The page size requested by the client.
The default value is 20. The maximal value is 200.
page[number]integer
The page number the client requests.
The first page is always page[number]=1.
sortstring
Sort query parameter permits the sorting of the collection by the values of the attribute provided in the parameter:
GET /calculations?sort=+attribute
The type of sort:
- (+) Indicates ascending order. +attribute
- (-) Indicates descending order. -attribute
- If no symbol is provided, any default order could be returned
If sort is not provided, the collection is returned in a default order by ID.
The name of the attribute should exists in the object. If the name does not exists, it returns 400 Bad Request.
Path Parameters
simulationIdstring(string)required
UUID type implementing the RFC 4122.
Match pattern:^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$
Example:95b1b467-bd69-4436-8181-96c16408c230
Response
application/vnd.api+json
Response
application/vnd.api+json
Ok
CalculationsJsonApiType
Collection in JSON:API format. Collection is paginated
linksobjectrequired
Show Child Parameters
dataarray[object]requiredread-only
Data structure for all operations.
Show Child Parameters
metaobjectrequired
Show Child Parameters
get/simulations/{simulationId}/calculations
Path Parameters
Query Parameters
application/vnd.api+json
Creates a new object of in the collection Calculations
Creates a new object of in the collection Calculations
post
Path Parameters
simulationIdstring(string)required
UUID type implementing the RFC 4122.
Match pattern:^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$
Example:95b1b467-bd69-4436-8181-96c16408c230
Response
application/vnd.api+json
Response
application/vnd.api+json
Ok
CalculationJsonApiType
Object in JSON:API format.
dataobjectrequired
Data structure for all operations.
Show Child Parameters
post/simulations/{simulationId}/calculations
Path Parameters
application/vnd.api+json
Retrieves one specific object from collection Calculations
Retrieves one specific object from collection Calculations
get
Path Parameters
simulationIdstring(string)required
UUID type implementing the RFC 4122.
Match pattern:^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$
Example:95b1b467-bd69-4436-8181-96c16408c230
calculationIdstring(string)required
UUID type implementing the RFC 4122.
Match pattern:^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$
Example:95b1b467-bd69-4436-8181-96c16408c230
Response
application/vnd.api+json
Response
application/vnd.api+json
Ok
CalculationJsonApiType
Object in JSON:API format.
dataobjectrequired
Data structure for all operations.
Show Child Parameters
get/simulations/{simulationId}/calculations/{calculationId}
Path Parameters
application/vnd.api+json