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

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

# CalculationsJsonApiType

Collection in JSON:API format. Collection is paginated

## 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:
    LinksPaginationType:
      required:
        - first
        - last
      type: object
      properties:
        first:
          type: string
          description: First position of the collection
          example: https://api.domain.com/resources?page[number]=1
        last:
          type: string
          description: Last page of the collection
          example: https://api.domain.com/resources?page[number]=50
        prev:
          type: string
          description: Navigates to the previous page on the list provided. If the page is
            the first one, prev should be null or not be present
          example: https://api.domain.com/resources?page[number]=1
        next:
          type: string
          description: Navigates to the next page on the list provided. If the page is the
            last one, prev should be null or not be present
          example: https://api.domain.com/resources?page[number]=3
    CalculationType:
      type: object
      description: Data structure for all operations.
      allOf:
        - type: object
          properties:
            attributes:
              $ref: "#/components/schemas/CalculationAttributesType"
        - $ref: "#/components/schemas/BasicResourceType"
    MetaType:
      type: object
      properties:
        history:
          $ref: "#/components/schemas/MetaHistoryType"
        pagination:
          $ref: "#/components/schemas/PaginationType"
    CalculationAttributesType:
      required:
        - status
      type: object
      properties:
        date:
          type: string
          description: Creation date of the calculation
          format: date-time
          example: 2022-01-02T18:25:43.511Z
        status:
          type: string
          description: Status of the calculation process
          example: IN-PROGRESS
          enum:
            - IN-PROGRESS
            - DONE
      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
    MetaHistoryType:
      title: MetaHistoryType
      required:
        - created
      type: object
      properties:
        created:
          type: string
          description: When the JSON:API Object has been created
          format: date-time
          example: 2022-01-02T18:25:43.511Z
        createdBy:
          type: string
          description: Who created the JSON:API object. This should not share login
            information (by example, use email)
          example: chris.doe@sixgroup.com
        lastModified:
          type: string
          description: When the object has been modified by the last time. This is
            optional value.
          format: date-time
          example: 2022-01-02T18:25:43.511Z
        lastModifiedBy:
          type: string
          description: Who modified the JSON:API object.
          example: michael.rodriguez@sixgroup.com
        version:
          type: string
          description: This is the version of the object. Should contain hash of the
            object to detect if this has changed before commit again new
            changes.
          example: AF9e94334rr44
      description: Contains the historical information object
    PaginationType:
      title: PaginationType
      type: object
      properties:
        totalEntities:
          type: integer
          description: >-
            Total of the entities returned in the collection. Depending of the
            operation pattern:
             * SEARCH: return the number of elements of the search criteria
             * GET: return all the elements or the search criteria
          format: int32
        totalPages:
          type: integer
          description: "Total of the pages that the collection could return. Last page =
            to totalPages. "
          format: int32
        pageSize:
          type: integer
          description: Size of the page.
          format: int32
        page:
          type: integer
          description: Current Page of the return collection
          format: int32
    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
    CalculationsJsonApiType:
      required:
        - data
        - links
        - meta
      type: object
      properties:
        links:
          $ref: "#/components/schemas/LinksPaginationType"
        data:
          type: array
          description: List of **MESSAGES** present in the collection, resulting on the
            query request.
          readOnly: true
          items:
            $ref: "#/components/schemas/CalculationType"
        meta:
          $ref: "#/components/schemas/MetaType"
      description: Collection in JSON:API format. Collection is paginated
```