---
title: "SimulationType"
url: "https://apiportal-qa.np.six-group.com/apis/simulator-ch-qa-v1/versions/c729661a-062a-4141-9704-f637226fa5f0/schemas/SimulationType"
---

> Full API specification: https://apiportal-qa.np.six-group.com/apis/simulator-ch-qa-v1/versions/c729661a-062a-4141-9704-f637226fa5f0.md

# SimulationType

Data structure for all operations.

## OpenAPI definition

```yaml
openapi: 3.0.2
info:
  title: DCleaR - Risk Simulator API - v1
  version: 1.0.0
servers:
  - url: https://api-qa.np.six-group.com/clearing/risk/simulator/dev/v1
  - url: https://api-qa.np.p2p.six-group.com/clearing/risk/simulator/dev/v1
  - url: https://api-qa.np.fip.six-group.com/clearing/risk/simulator/dev/v1
components:
  schemas:
    SimulationAttributesType:
      required:
        - algorithmType
        - calculationType
        - name
        - simulationType
      type: object
      properties:
        date:
          type: string
          description: Simulation date. The value here represent the date that the
            algorithm should take in account for the margin calculations.
          format: date
          example: 2023-09-15
        name:
          maxLength: 120
          minLength: 1
          type: string
          description: Simulation name, given by the user.
          example: Simulation-1
        simulationType:
          type: string
          description: Type of simulation done by the system.
          enum:
            - GUARANTEE
            - POSITION
        calculationType:
          type: string
          description: Type of calculation done in the simulation
          enum:
            - MODEL
            - RISK-CONTROL
        algorithmType:
          type: string
          description: Type of algorithm applied in the simulation.
          enum:
            - IM
            - ST
      description: Basic attributes of the object.
    BasicResourceType:
      required:
        - type
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUIDType"
        type:
          type: string
          description: Type of the resource attributes being represented
          example: simulation
          enum:
            - simulation
            - calculation
            - result
            - open-position
            - import-open-positions
            - result-detail
            - report
    UUIDType:
      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}$
      type: string
      description: UUID type implementing the [RFC
        4122](https://www.ietf.org/rfc/rfc4122.txt).
      format: string
      example: 95b1b467-bd69-4436-8181-96c16408c230
    SimulationType:
      type: object
      description: Data structure for all operations.
      allOf:
        - type: object
          properties:
            attributes:
              $ref: "#/components/schemas/SimulationAttributesType"
        - $ref: "#/components/schemas/BasicResourceType"
```