CalculationAttributesType

object

Basic attributes of the object.

datestring(date-time)

Creation date of the calculation

Example:2022-01-02T18:25:43.511Z

statusstringrequired

Status of the calculation process

Allowed values:IN-PROGRESSDONE

Example:IN-PROGRESS

Example

SimulationType

object

Data structure for all operations.

attributesobject

Basic attributes of the object.

Show Child Parameters
idstring(string)

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

typestringrequired

Type of the resource attributes being represented

Allowed values:simulationcalculationresultopen-positionimport-open-positionsresult-detailreport

Example:simulation

Example

CalculationType

object

Data structure for all operations.

attributesobject

Basic attributes of the object.

Show Child Parameters
idstring(string)

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

typestringrequired

Type of the resource attributes being represented

Allowed values:simulationcalculationresultopen-positionimport-open-positionsresult-detailreport

Example:simulation

Example

OpenPositionType

object

Data structure for all operations.

attributesobject

Basic attributes of the object.

Show Child Parameters
idstring(string)

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

typestringrequired

Type of the resource attributes being represented

Allowed values:simulationcalculationresultopen-positionimport-open-positionsresult-detailreport

Example:simulation

Example

SimulationAttributesType

object

Basic attributes of the object.

datestring(date)

Simulation date. The value here represent the date that the algorithm should take in account for the margin calculations.

Example:2023-09-15

namestringrequired

Simulation name, given by the user.

>= 1 characters<= 120 characters

Example:Simulation-1

simulationTypestringrequired

Type of simulation done by the system.

Allowed values:GUARANTEEPOSITION

calculationTypestringrequired

Type of calculation done in the simulation

Allowed values:MODELRISK-CONTROL

algorithmTypestringrequired

Type of algorithm applied in the simulation.

Allowed values:IMST

Example