Cognite Simulator Models API

The simulator model resource represents an asset modeled in a simulator. This asset could range from a pump or well to a complete processing facility or refinery. The simulator model is the root of its associated revisions, routines, runs, and results. The dataset assigned to a model is inherited by its children. Deleting a model also deletes all its children, thereby maintaining the integrity and hierarchy of the simulation data. Simulator model revisions track changes and updates to a simulator model over time. Each revision ensures that modifications to models are traceable and allows users to understand the evolution of a given model. #### Limitations: - A project can have a maximum of 1000 simulator models. - Each simulator model can have a maximum of 200 revisions.

OpenAPI Specification

cognite-simulator-models-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Cognite 3D Asset Mapping Simulator Models API
  description: "# Introduction\nThis is the reference documentation for the Cognite API with\nan overview of all the available methods.\n\n# Postman\nSelect the **Download** button to download our OpenAPI specification to get started.\n\nTo import your data into Postman, select **Import**, and the Import modal opens.\nYou can import items by dragging or dropping files or folders. You can choose how to import your API and manage the import settings in **View Import Settings**.\n\nIn the Import Settings, set the **Folder organization** to **Tags**, select\n**Enable optional parameters** to turn off the settings, and select **Always inherit authentication** to turn on the settings. Select **Import**.\n\nSet the Authorization to **Oauth2.0**. By default, the settings are for Open Industrial Data. Navigate to [Cognite Hub](https://hub.cognite.com/open-industrial-data-211) to understand how to get the credentials for use in Postman.\n\nFor more information, see [Getting Started with Postman](https://developer.cognite.com/dev/guides/postman/).\n\n# Pagination\nMost resource types can be paginated, indicated by the field `nextCursor` in the response.\nBy passing the value of `nextCursor` as the cursor you will get the next page of `limit` results.\nNote that all parameters except `cursor` has to stay the same.\n\n# Parallel retrieval\nAs general guidance, Parallel Retrieval is a technique that should be used when due to query complexity, retrieval of data in a single request is significantly slower than it would otherwise be for a simple request.  Parallel retrieval does not act as a speed multiplier on optimally running queries.  By parallelizing such requests, data retrieval performance can be tuned to meet the client application needs. \n\nCDF supports parallel retrieval through the `partition` parameter, which has the format `m/n` where `n` is the amount of partitions you would like to split the entire data set into.\nIf you want to download the entire data set by splitting it into 10 partitions, do the following in parallel with `m` running from 1 to 10:\n  - Make a request to `/events` with `partition=m/10`.\n  - Paginate through the response by following the cursor as explained above. Note that the `partition` parameter needs to be passed to all subqueries.\n\nProcessing of parallel retrieval requests is subject to concurrency quota availability. The request returns the `429` response upon exceeding concurrency limits. See the Request throttling chapter below.\n\nTo prevent unexpected problems and to maximize read throughput, you should at most use 10 partitions. \nSome CDF resources will automatically enforce a maximum of 10 partitions.\nFor more specific and detailed information, please read the ```partition``` attribute documentation for the CDF resource you're using.  \n\n# Requests throttling\nCognite Data Fusion (CDF) returns the HTTP `429` (too many requests) response status code when project capacity exceeds the limit.\n\nThe throttling can happen:\n  - If a user or a project sends too many (more than allocated) concurrent requests.\n  - If a user or a project sends a too high (more than allocated) rate of requests in a given amount of time.\n\nCognite recommends using a retry strategy based on truncated exponential backoff to handle sessions with HTTP response codes 429.\n\nCognite recommends using a reasonable number (up to 10) of  `Parallel retrieval` partitions.\n\nFollowing these strategies lets you slow down the request frequency to maximize productivity without having to re-submit/retry failing requests.\n\nSee more [here](https://docs.cognite.com/dev/concepts/resource_throttling).\n\n# API versions\n## Version headers\nThis API uses calendar versioning, and version names follow the `YYYYMMDD` format.\nYou can find the versions currently available by using the version selector at the top of this page.\n\nTo use a specific API version, you can pass the `cdf-version: $version` header along with your requests to the API.\n\n## Beta versions\nThe beta versions provide a preview of what the stable version will look like in the future.\nBeta versions contain functionality that is reasonably mature, and highly likely to become a part of the stable API.\n\nBeta versions are indicated by a `-beta` suffix after the version name. For example, the beta version header for the\n2023-01-01 version is then `cdf-version: 20230101-beta`.\n\n## Alpha versions\nAlpha versions contain functionality that is new and experimental, and not guaranteed to ever become a part of the stable API.\nThis functionality presents no guarantee of service, so its use is subject to caution.\n\nAlpha versions are indicated by an `-alpha` suffix after the version name. For example, the alpha version header for\nthe 2023-01-01 version is then `cdf-version: 20230101-alpha`."
  version: v1
  contact:
    name: Cognite Support
    url: https://support.cognite.com
    email: support@cognite.com
servers:
- url: https://{cluster}.cognitedata.com/api/v1/projects/{project}
  description: The URL for the CDF cluster to connect to
  variables:
    cluster:
      enum:
      - api
      - az-tyo-gp-001
      - az-eastus-1
      - az-power-no-northeurope
      - westeurope-1
      - asia-northeast1-1
      - gc-dsm-gp-001
      default: api
      description: The CDF cluster to connect to
    project:
      default: publicdata
      description: The CDF project name.
security:
- oidc-token:
  - https://{cluster}.cognitedata.com/.default
- oauth2-client-credentials:
  - https://{cluster}.cognitedata.com/.default
- oauth2-open-industrial-data:
  - https://api.cognitedata.com/.default
- oauth2-auth-code:
  - https://{cluster}.cognitedata.com/.default
tags:
- name: Simulator Models
  description: '


    The simulator model resource represents an asset modeled in a simulator. This asset could range from a pump or well to a complete processing facility or refinery.

    The simulator model is the root of its associated revisions, routines, runs, and results. The dataset assigned to a model is inherited by its children. Deleting a model also deletes all its children, thereby maintaining the integrity and hierarchy of the simulation data.


    Simulator model revisions track changes and updates to a simulator model over time. Each revision ensures that modifications to models are traceable and allows users to understand the evolution of a given model.


    #### Limitations:


    - A project can have a maximum of 1000 simulator models.

    - Each simulator model can have a maximum of 200 revisions.

    '
paths:
  /simulators/models:
    post:
      tags:
      - Simulator Models
      summary: Create Simulator Model
      description: Create a simulator model.
      operationId: create_simulator_model_simulators_models_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SingleItemSimulatorModelCreateCommand'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSimulatorModel'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Bad Request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Internal Server Error
  /simulators/models/list:
    post:
      tags:
      - Simulator Models
      summary: Filter Simulator Models
      description: Retrieves a list of simulator models that match the given criteria.
      operationId: filter_simulator_models_simulators_models_list_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSimulatorModelsQuery'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWithCursorSimulatorModel'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Bad Request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Internal Server Error
  /simulators/models/aggregate:
    post:
      tags:
      - Simulator Models
      summary: Aggregate Simulator Models
      description: Calculate aggregates for simulator models, considering the optional filter specification.
      operationId: aggregate_simulator_models
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AggregateSimulatorModelsQuery'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAggregateCount'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Bad Request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Internal Server Error
  /simulators/models/delete:
    post:
      tags:
      - Simulator Models
      summary: Delete Simulator Model
      description: Delete a simulator model. This will also delete all associated simulator resources (e.g. revisions, routines, runs).
      operationId: delete_simulator_model_simulators_models_delete_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SingleItemIdRefOrExternalIdRef'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Internal Server Error
  /simulators/models/update:
    post:
      tags:
      - Simulator Models
      summary: Update Simulator Model
      description: Update a simulator model.
      operationId: update_simulator_model_simulators_models_update_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SingleItemSimulatorModelUpdateCommand'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSimulatorModel'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Bad Request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Internal Server Error
  /simulators/models/byids:
    post:
      tags:
      - Simulator Models
      summary: Retrieve Simulator Model
      description: Retrieve a simulator model by ID or external ID.
      operationId: retrieve_simulator_model_simulators_models_byids_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SingleItemIdRefOrExternalIdRef'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSimulatorModel'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Bad Request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Internal Server Error
  /simulators/models/revisions:
    post:
      tags:
      - Simulator Models
      summary: Create Simulator Model Revision
      description: Create a simulator model revision.
      operationId: create_simulator_model_revision_simulators_models_revisions_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SingleItemSimulatorModelRevisionCreateCommand'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSimulatorModelRevision'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Bad Request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Internal Server Error
  /simulators/models/revisions/list:
    post:
      tags:
      - Simulator Models
      summary: Filter Simulator Model Revisions
      description: Retrieves a list of simulator model revisions that match the given criteria.
      operationId: filter_simulator_model_revisions_simulators_models_revisions_list_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSimulatorModelRevisionsQuery'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWithCursorSimulatorModelRevisionView'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Bad Request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Internal Server Error
  /simulators/models/revisions/byids:
    post:
      tags:
      - Simulator Models
      summary: Retrieve Simulator Model Revisions
      description: Retrieve one or more simulator model revisions by IDs or external IDs.
      operationId: retrieve_simulator_model_revisions_simulators_models_revisions_byids_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InputItemsIdRefOrExternalIdRef'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSimulatorModelRevision'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Bad Request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Internal Server Error
components:
  schemas:
    SortByCreatedTime:
      properties:
        order:
          anyOf:
          - type: string
            const: asc
            enum:
            - asc
          - type: string
            const: desc
            enum:
            - desc
          title: Order
          description: Sort order
        property:
          type: string
          const: createdTime
          title: Property
          description: Name of the property to sort by
          enum:
          - createdTime
      additionalProperties: false
      type: object
      required:
      - order
      - property
      title: SortByCreatedTime
    SingleItemSimulatorModelCreateCommand:
      properties:
        items:
          items:
            $ref: '#/components/schemas/SimulatorModelCreateCommand'
          type: array
          title: Items
          description: A list with a single item
      additionalProperties: false
      type: object
      required:
      - items
      title: SingleItemSimulatorModelCreateCommand
    UpdateSetShortStr:
      properties:
        set:
          type: string
          maxLength: 50
          minLength: 1
          title: Set
          description: Value to set
      additionalProperties: false
      type: object
      required:
      - set
      title: UpdateSetShortStr
    SingleItemIdRefOrExternalIdRef:
      properties:
        items:
          items:
            anyOf:
            - $ref: '#/components/schemas/IdRef'
            - $ref: '#/components/schemas/ExternalIdRef'
          type: array
          title: Items
          description: A list with a single item
      additionalProperties: false
      type: object
      required:
      - items
      title: SingleItemIdRefOrExternalIdRef
    SimulatorModel:
      properties:
        dataSetId:
          type: integer
          title: DataSetId
          description: Dataset id of the resource
          examples:
          - 5559452808603919
        id:
          type: integer
          title: Id
          description: A unique id of a simulation model
        externalId:
          type: string
          title: ExternalId
          description: External id of the simulation model
        simulatorExternalId:
          type: string
          title: SimulatorExternalId
          description: External id of the simulator
        name:
          type: string
          title: Name
          description: Name of the simulation model
        description:
          title: Description
          description: Description of the simulation model
          type: string
        type:
          title: Type
          description: Model type of the simulation model. List of available types is available in the simulator resource.
          type: string
        createdTime:
          type: integer
          title: CreatedTime
        lastUpdatedTime:
          type: integer
          title: LastUpdatedTime
      additionalProperties: false
      type: object
      required:
      - dataSetId
      - id
      - externalId
      - simulatorExternalId
      - name
      - createdTime
      - lastUpdatedTime
      title: SimulatorModel
    ListAggregateCount:
      properties:
        items:
          items:
            $ref: '#/components/schemas/AggregateCount'
          type: array
          title: Items
      additionalProperties: false
      type: object
      required:
      - items
      title: ListAggregateCount
    SimulatorModelRevisionCreateCommand:
      properties:
        externalId:
          type: string
          maxLength: 255
          minLength: 1
          title: ExternalId
          description: External id of the simulation model revision
        modelExternalId:
          type: string
          title: ModelExternalId
          description: External id of the simulation model
        description:
          title: Description
          description: Description of the simulation model revision
          type: string
          maxLength: 255
          minLength: 1
        fileId:
          type: integer
          title: FileId
          description: Source file id of the simulation model revision
      additionalProperties: false
      type: object
      required:
      - externalId
      - modelExternalId
      - fileId
      title: SimulatorModelRevisionCreateCommand
    ExternalIdRef:
      properties:
        externalId:
          type: string
          title: ExternalId
          description: String-based ID
      additionalProperties: false
      type: object
      required:
      - externalId
      title: ExternalIdRef
    EmptyResponse:
      properties: {}
      type: object
      title: EmptyResponse
    APIError:
      properties:
        message:
          type: string
          title: Message
        code:
          type: integer
          title: Code
      type: object
      required:
      - message
      - code
      title: APIError
    AggregateSimulatorModelsQuery:
      properties:
        filter:
          $ref: '#/components/schemas/ListSimulatorModelsFilters'
        aggregate:
          type: string
          const: count
          title: Aggregate
          description: Aggregate type
          enum:
          - count
      additionalProperties: false
      type: object
      required:
      - aggregate
      title: AggregateSimulatorModelsQuery
    SimulatorModelCreateCommand:
      properties:
        externalId:
          type: string
          maxLength: 255
          minLength: 1
          title: ExternalId
          description: External id of the simulation model
        simulatorExternalId:
          type: string
          maxLength: 50
          minLength: 1
          title: SimulatorExternalId
          description: External id of the simulator
        name:
          type: string
          maxLength: 50
          minLength: 1
          title: Name
          description: Name of the simulation model
        description:
          title: Description
          description: Description of the simulation model
          type: string
          maxLength: 255
          minLength: 1
        dataSetId:
          type: integer
          title: DataSetId
          description: Data set id of the simulation model
        type:
          type: string
          maxLength: 50
          minLength: 1
          title: Type
          description: Model type of the simulation model. List of available types is available in the simulator resource.
      additionalProperties: false
      type: object
      required:
      - externalId
      - simulatorExternalId
      - name
      - dataSetId
      - type
      title: SimulatorModelCreateCommand
    ListSimulatorModelsFilters:
      properties:
        simulatorExternalIds:
          title: SimulatorExternalIds
          description: Filter by simulator external ids
          examples:
          - - PROSPER
          items:
            type: string
          type: array
          maxItems: 100
          minItems: 1
        externalIdPrefix:
          title: ExternalIdPrefix
          description: Filter by prefix on simulator model external ids
          type: string
          maxLength: 255
          minLength: 1
        dataSetIds:
          title: DataSetIds
          description: Filter by data set IDs
          items:
            type: integer
          type: array
          maxItems: 100
          minItems: 1
      additionalProperties: false
      type: object
      title: ListSimulatorModelsFilters
    UpdateSetString:
      properties:
        set:
          type: string
          maxLength: 255
          minLength: 1
          title: Set
          description: Value to set
      additionalProperties: false
      type: object
      required:
      - set
      title: UpdateSetString
    AggregateCount:
      properties:
        count:
          type: integer
          title: Count
          description: Number of items
      additionalProperties: false
      type: object
      required:
      - count
      title: AggregateCount
    SimulatorModelUpdate:
      properties:
        name:
          description: Name of the model
          examples:
          - set: Model for PROSPER
          $ref: '#/components/schemas/UpdateSetShortStr'
        description:
          description: Description of the simulation model
          $ref: '#/components/schemas/UpdateSetString'
      additionalProperties: false
      type: object
      title: SimulatorModelUpdate
    ListSimulatorModelRevision:
      properties:
        items:
          items:
            $ref: '#/components/schemas/SimulatorModelRevision'
          type: array
          title: Items
      additionalProperties: false
      type: object
      required:
      - items
      title: ListSimulatorModelRevision
    SingleItemSimulatorModelUpdateCommand:
      properties:
        items:
          items:
            $ref: '#/components/schemas/SimulatorModelUpdateCommand'
          type: array
          title: Items
          description: A list with a single item
      additionalProperties: false
      type: object
      required:
      - items
      title: SingleItemSimulatorModelUpdateCommand
    SimulatorModelUpdateCommand:
      properties:
        id:
          type: integer
          title: Id
          description: Id of the simulator model
        update:
          $ref: '#/components/schemas/SimulatorModelUpdate'
      additionalProperties: false
      type: object
      required:
      - id
      - update
      title: SimulatorModelUpdateCommand
    ListWithCursorSimulatorModel:
      properties:
        items:
          items:
            $ref: '#/components/schemas/SimulatorModel'
          type: array
          title: Items
        nextCursor:
          title: NextCursor
          type: string
      additionalProperties: false
      type: object
      required:
      - items
      title: ListWithCursorSimulatorModel
    SingleItemSimulatorModelRevisionCreateCommand:
      properties:
        items:
          items:
            $ref: '#/components/schemas/SimulatorModelRevisionCreateCommand'
          type: array
          title: Items
          description: A list with a single item
      additionalProperties: false
      type: object
      required:
      - items
      title: SingleItemSimulatorModelRevisionCreateCommand
    ListSimulatorModelRevisionsFilters:
      properties:
        modelExternalIds:
          title: ModelExternalIds
          description: Filter by model external ids
          examples:
          - - model_1
            - model_2
          items:
            type: string
          type: array
          maxItems: 100
          minItems: 1
        simulatorExternalIds:
          title: SimulatorExternalIds
          description: Filter by simulator external ids
          examples:
          - - PROSPER
            - PetroSIM
          items:
            type: string
            maxLength: 50
            minLength: 1
          type: array
          maxItems: 100
          minItems: 1
        allVersions:
          title: AllVersions
          description: If all versions of the entity should be returned. Defaults to false which returns only the latest revision for each model.
          default: false
          type: boolean
        createdTime:
          description: Filter by created time range
          $ref: '#/components/schemas/EpochTimestampRange'
        lastUpdatedTime:
          description: Filter by last updated time range
          $ref: '#/components/schemas/EpochTimestampRange'
      additionalProperties: false
      type: object
      title: ListSimulatorModelRevisionsFilters
    InputItemsIdRefOrExternalIdRef:
      properties:
        items:
          items:
            anyOf:
            - $ref: '#/components/schemas/IdRef'
            - $ref: '#/components/schemas/ExternalIdRef'
          type: array
          maxItems: 100
          minItems: 1
          title: Items
          description: A list of items
      additionalProperties: false
      type: object
      required:
      - items
      title: InputItemsIdRefOrExternalIdRef
    EpochTimestampRange:
      description: Range between two timestamps (inclusive).
      type: object
      properties:
        max:
          description: Maximum timestamp (inclusive). The timestamp is represented as number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
          type: integer
          minimum: 0
          format: int64
        min:
          description: Minimum timestamp (inclusive). The timestamp is represented as number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
          type: integer
          minimum: 0
          format: int64
    ListSimulatorModelRevisionsQuery:
      properties:
        filter:
          $ref: '#/components/schemas/ListSimulatorModelRevisionsFilters'
        limit:
          type: integer
          maximum: 1000
          minimum: 1
          title: Limit
          default: 1000
        cursor:
          title: Cursor
          description: Cursor for pagination
          type: string
        sort:
          title: Sort
          description: Only supports sorting by one property at a time
          items:
            $ref: '#/components/schemas/SortByCreatedTime'
          type: array
      additionalProperties: false
      type: object
      title: ListSimulatorModelRevisionsQuery
    ListSimulatorModel:
      properties:
        items:
          items:
            $ref: '#/components/schemas/SimulatorModel'
          type: array
          title: Items
      additionalProperties: false
      type: object
      required:
      - items
      title: ListSimulatorModel
    SimulatorModelRevisionStatus:
      type: string
      enum:
      - unknown
      - success
      - failure
      title: SimulatorModelRevisionStatus
    SimulatorModelRevisionView:
      properties:
        dataSetId:
          type: integer
          title: DataSetId
          description: Dataset id of the resource
          examples:
          - 5559452808603919
        id:
          type: integer
          title: Id
          description: A unique id of a simulation model revision
        externalId:
          type: string
          title: ExternalId
          description: External id of the simulation model revision
        simulatorExternalId:
          type: string
          title: SimulatorExternalId
          description: External id of the simulator
        modelExternalId:
          type: string
          title: ModelExternalId
          description: External id of the simulation model
        description:
          title: Description
          description: Description of the simulation model revision
          type: string
        fileId:
          type: integer
          title: FileId
          description: Source file id of the simulation model revision
        createdByUserId:
          type: string
          title: CreatedByUserId
          description: Author of the simulation model revision
        status:
          $ref: '#/components/schemas/SimulatorModelRevisionStatus'
          description: Status of the simulation model revision
          default: unknown
        statusMessage:
          title: StatusMessage
          description: Status mes

# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cognite/refs/heads/main/openapi/cognite-simulator-models-api-openapi.yml