Cognite Simulator Routines API

The simulator routine resource defines instructions on interacting with a simulator model. A simulator routine includes: - Inputs (values set into the simulator model) - Commands (actions to be performed by the simulator) - Outputs (values read from the simulator model) Simulator routines can have multiple revisions, enabling users to track changes and evolve the routine over time. Each model can have multiple routines, each performing different objectives such as calculating optimal operation setpoints, forecasting production, benchmarking asset performance, and more. #### Limitations: - A project can have a maximum of 10000 simulator routines. - Each simulator model can have a maximum of 10 simulator routines. - Each simulator routine can have a maximum of 10 revisions. - The total size of each routine revision can be a maximum of 50.00 KB.

OpenAPI Specification

cognite-simulator-routines-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Cognite 3D Asset Mapping Simulator Routines 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 Routines
  description: '


    The simulator routine resource defines instructions on interacting with a simulator model. A simulator routine includes:

    - Inputs (values set into the simulator model)

    - Commands (actions to be performed by the simulator)

    - Outputs (values read from the simulator model)


    Simulator routines can have multiple revisions, enabling users to track changes and evolve the routine over time. Each model can have multiple routines, each performing different objectives such as calculating optimal operation setpoints, forecasting production, benchmarking asset performance, and more.


    #### Limitations:


    - A project can have a maximum of 10000 simulator routines.

    - Each simulator model can have a maximum of 10 simulator routines.

    - Each simulator routine can have a maximum of 10 revisions.

    - The total size of each routine revision can be a maximum of  50.00 KB.

    '
paths:
  /simulators/routines:
    post:
      tags:
      - Simulator Routines
      summary: Create Simulator Routine
      description: Create a simulator routine.
      operationId: create_simulator_routine_simulators_routines_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SingleItemSimulatorRoutineCreateCommand'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSimulatorRoutineBase'
        '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/routines/list:
    post:
      tags:
      - Simulator Routines
      summary: Filter Simulator Routines
      description: Retrieves a list of simulator routines that match the given criteria.
      operationId: filter_simulator_routines_simulators_routines_list_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSimulatorRoutinesQuery'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWithCursorSimulatorRoutineBase'
        '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/routines/delete:
    post:
      tags:
      - Simulator Routines
      summary: Delete Simulator Routine
      description: Delete a simulator routine. This will also delete all associated simulator resources (e.g. revisions, runs, data).
      operationId: delete_simulator_routine_simulators_routines_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/routines/aggregate:
    post:
      tags:
      - Simulator Routines
      summary: Aggregate Simulator Routines
      description: Calculate aggregates for simulator routines, considering the optional filter specification.
      operationId: aggregate_simulator_routines
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AggregateSimulatorRoutinesQuery'
      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/routines/revisions:
    post:
      tags:
      - Simulator Routines
      summary: Create Simulator Routine Revision
      description: 'The total size of the request body can be a maximum of 50.00 KB.


        When creating a simulator routine revision, be mindful of the following:


        - The amount and size of the inputs you provide to the simulator routine.

        - The size of the outputs you expect from the simulator routine.


        The total size of the data sent by a simulator connector cannot exceed 100.00 KB per simulation run.'
      operationId: create_simulator_routine_revision_simulators_routines_revisions_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SingleItemSimulatorRoutineRevisionCreateCommand'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSimulatorRoutineRevision'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Bad Request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Forbidden
        '413':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Request Entity Too Large
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBase'
          description: Internal Server Error
  /simulators/routines/revisions/list:
    post:
      tags:
      - Simulator Routines
      summary: Filter Simulator Routine Revisions
      description: Retrieves a list of simulator routine revisions that match the given criteria.
      operationId: filter_simulator_routine_revisions_simulators_routines_revisions_list_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSimulatorRoutineRevisionsQuery'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ListWithCursorSimulatorRoutineRevision'
                - $ref: '#/components/schemas/ListWithCursorSimulatorRoutineRevisionView'
                title: Response Filter Simulator Routine Revisions Simulators Routines Revisions List Post
        '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/routines/revisions/byids:
    post:
      tags:
      - Simulator Routines
      summary: Retrieve Simulator Routine Revisions
      description: Retrieve one or more simulator routine revisions by IDs or external IDs.
      operationId: retrieve_simulator_routine_revisions_simulators_routines_revisions_byids_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InputItems20IdRefOrExternalIdRef'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSimulatorRoutineRevision'
        '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:
    ListSimulatorRoutinesFilters:
      properties:
        modelExternalIds:
          title: ModelExternalIds
          description: Filter by simulator model external ids
          examples:
          - - model_1
            - model_2
          items:
            type: string
          type: array
          maxItems: 100
          minItems: 1
        simulatorIntegrationExternalIds:
          title: SimulatorIntegrationExternalIds
          description: Filter by simulator integration external ids
          examples:
          - - simulator_integration_1
            - simulator_integration_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
      additionalProperties: false
      type: object
      title: ListSimulatorRoutinesFilters
    SimulatorRoutineStepArgumentsSet:
      properties:
        referenceId:
          type: string
          maxLength: 50
          minLength: 1
          title: ReferenceId
          description: A unique id to the input time series (or a constant) defined in the routine configuration.
      additionalProperties: true
      type: object
      required:
      - referenceId
      title: SimulatorRoutineStepArgumentsSet
    SimulatorRoutineDataSamplingEnabled:
      properties:
        enabled:
          type: boolean
          const: true
          title: Enabled
          description: Whether the data sampling is enabled or not
          enum:
          - true
        validationWindow:
          title: ValidationWindow
          description: Validation window of the data sampling. Represented in minutes. Used when either logical check or steady state detection is enabled.
          type: integer
        samplingWindow:
          type: integer
          title: SamplingWindow
          description: Sampling window of the data sampling. Represented in minutes
        granularity:
          type: integer
          title: Granularity
          description: Granularity of the data sampling in minutes
      additionalProperties: false
      type: object
      required:
      - enabled
      - samplingWindow
      - granularity
      title: SimulatorRoutineDataSamplingEnabled
    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
    SimulatorRoutineConfigurationCreate:
      properties:
        schedule:
          anyOf:
          - $ref: '#/components/schemas/SimulatorRoutineConfigDisabled'
          - $ref: '#/components/schemas/SimulatorRoutineScheduleEnabled'
          title: Schedule
        dataSampling:
          anyOf:
          - $ref: '#/components/schemas/SimulatorRoutineConfigDisabled'
          - $ref: '#/components/schemas/SimulatorRoutineDataSamplingEnabled'
          title: DataSampling
        logicalCheck:
          items:
            $ref: '#/components/schemas/SimulatorRoutineLogicalCheckEnabled'
          type: array
          maxItems: 1
          minItems: 0
          title: LogicalCheck
          description: List of logical check rules. Used to find out data points which satisfy the logical check.
        steadyStateDetection:
          items:
            $ref: '#/components/schemas/SimulatorRoutineSteadyStateDetectionEnabled'
          type: array
          maxItems: 1
          minItems: 0
          title: SteadyStateDetection
          description: List of steady state detection rules. Used to find out data points which are in steady state.
        inputs:
          items:
            oneOf:
            - $ref: '#/components/schemas/SimulatorRoutineInputConstant'
            - $ref: '#/components/schemas/SimulatorRoutineInputTimeseries'
            description: Input item for the simulation routine
          type: array
          maxItems: 10000
          title: Inputs
          description: List of input constants and input time series. Used to define the inputs of the simulation routine.
          default: []
        outputs:
          items:
            $ref: '#/components/schemas/SimulatorRoutineOutput'
          type: array
          maxItems: 10000
          title: Outputs
          description: List of outputs for the simulation routine.
          default: []
      additionalProperties: false
      type: object
      required:
      - schedule
      - dataSampling
      - logicalCheck
      - steadyStateDetection
      title: SimulatorRoutineConfigurationCreate
    DataPointsAggregate:
      type: string
      enum:
      - average
      - interpolation
      - stepInterpolation
      title: DataPointsAggregate
    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
    ListAggregateCount:
      properties:
        items:
          items:
            $ref: '#/components/schemas/AggregateCount'
          type: array
          title: Items
      additionalProperties: false
      type: object
      required:
      - items
      title: ListAggregateCount
    EmptyResponse:
      properties: {}
      type: object
      title: EmptyResponse
    InputItems20IdRefOrExternalIdRef:
      properties:
        items:
          items:
            anyOf:
            - $ref: '#/components/schemas/IdRef'
            - $ref: '#/components/schemas/ExternalIdRef'
          type: array
          maxItems: 20
          minItems: 1
          title: Items
          description: A list of items
      additionalProperties: false
      type: object
      required:
      - items
      title: InputItems20IdRefOrExternalIdRef
    ExternalIdRef:
      properties:
        externalId:
          type: string
          title: ExternalId
          description: String-based ID
      additionalProperties: false
      type: object
      required:
      - externalId
      title: ExternalIdRef
    APIError:
      properties:
        message:
          type: string
          title: Message
        code:
          type: integer
          title: Code
      type: object
      required:
      - message
      - code
      title: APIError
    SimulatorRoutineBase:
      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 routine
        externalId:
          type: string
          title: ExternalId
          description: External id of the simulation routine
        simulatorExternalId:
          type: string
          title: SimulatorExternalId
          description: External id of the simulator
        modelExternalId:
          type: string
          title: ModelExternalId
          description: External id of the simulation model
        simulatorIntegrationExternalId:
          title: SimulatorIntegrationExternalId
          description: External id of the simulator integration this routine belongs to. Null when simulation run load balancing is enabled for this routine.
          type: string
          maxLength: 255
          minLength: 1
        name:
          type: string
          title: Name
          description: Name of the simulation routine
        description:
          title: Description
          description: Description of the simulation routine
          type: string
        createdTime:
          type: integer
          title: CreatedTime
          description: The number of milliseconds since epoch
        lastUpdatedTime:
          type: integer
          title: LastUpdatedTime
          description: The number of milliseconds since epoch
      additionalProperties: false
      type: object
      required:
      - dataSetId
      - id
      - externalId
      - simulatorExternalId
      - modelExternalId
      - name
      - createdTime
      - lastUpdatedTime
      title: SimulatorRoutineBase
    SimulatorRoutineStepSet:
      properties:
        order:
          type: integer
          maximum: 10000
          minimum: 1
          title: Order
          description: Step number
        description:
          title: Description
          description: Step description
          type: string
          maxLength: 255
          minLength: 1
        stepType:
          type: string
          const: Set
          title: StepType
          description: Step type
          enum:
          - Set
        arguments:
          $ref: '#/components/schemas/SimulatorRoutineStepArgumentsSet'
          description: Step arguments
          examples:
          - objectName: WELL.A2
            objectProperty: Tempretature
            referenceId: CWTC
      additionalProperties: false
      type: object
      required:
      - order
      - stepType
      - arguments
      title: SimulatorRoutineStepSet
      description: Used to set the input of a simulation routine from timeseries or constant fields.
    SimulatorRoutineConfigurationBase:
      properties:
        schedule:
          anyOf:
          - $ref: '#/components/schemas/SimulatorRoutineConfigDisabled'
          - $ref: '#/components/schemas/SimulatorRoutineScheduleEnabled'
          title: Schedule
        dataSampling:
          anyOf:
          - $ref: '#/components/schemas/SimulatorRoutineConfigDisabled'
          - $ref: '#/components/schemas/SimulatorRoutineDataSamplingEnabled'
          title: DataSampling
        logicalCheck:
          items:
            $ref: '#/components/schemas/SimulatorRoutineLogicalCheckEnabled'
          type: array
          maxItems: 1
          minItems: 0
          title: LogicalCheck
          description: List of logical check rules. Used to find out data points which satisfy the logical check.
        steadyStateDetection:
          items:
            $ref: '#/components/schemas/SimulatorRoutineSteadyStateDetectionEnabled'
          type: array
          maxItems: 1
          minItems: 0
          title: SteadyStateDetection
          description: List of steady state detection rules. Used to find out data points which are in steady state.
      additionalProperties: false
      type: object
      required:
      - schedule
      - dataSampling
      - logicalCheck
      - steadyStateDetection
      title: SimulatorRoutineConfigurationBase
    ListSimulatorRoutineRevision:
      properties:
        items:
          items:
            $ref: '#/components/schemas/SimulatorRoutineRevision'
          type: array
          title: Items
      additionalProperties: false
      type: object
      required:
      - items
      title: ListSimulatorRoutineRevision
    ListSimulatorRoutineBase:
      properties:
        items:
          items:
            $ref: '#/components/schemas/SimulatorRoutineBase'
          type: array
          title: Items
      additionalProperties: false
      type: object
      required:
      - items
      title: ListSimulatorRoutineBase
    AggregateCount:
      properties:
        count:
          type: integer
          title: Count
          description: Number of items
      additionalProperties: false
      type: object
      required:
      - count
      title: AggregateCount
    SimulationValueType:
      type: string
      enum:
      - STRING
      - DOUBLE
      - STRING_ARRAY
      - DOUBLE_ARRAY
      title: SimulationValueType
    SimulatorRoutineConfiguration:
      properties:
        schedule:
          anyOf:
          - $ref: '#/components/schemas/SimulatorRoutineConfigDisabled'
          - $ref: '#/components/schemas/SimulatorRoutineScheduleEnabled'
          title: Schedule
        dataSampling:
          anyOf:
          - $ref: '#/components/schemas/SimulatorRoutineConfigDisabled'
          - $ref: '#/components/schemas/SimulatorRoutineDataSamplingEnabled'
          title: DataSampling
        logicalCheck:
          items:
            $ref: '#/components/schemas/SimulatorRoutineLogicalCheckEnabled'
          type: array
          maxItems: 1
          minItems: 0
          title: LogicalCheck
          description: List of logical check rules. Used to find out data points which satisfy the logical check.
        steadyStateDetection:
          items:
            $ref: '#/components/schemas/SimulatorRoutineSteadyStateDetectionEnabled'
          type: array
          maxItems: 1
          minItems: 0
          title: SteadyStateDetection
          description: List of steady state detection rules. Used to find out data points which are in steady state.
        inputs:
          items:
            oneOf:
            - $ref: '#/components/schemas/SimulatorRoutineInputConstant'
            - $ref: '#/components/schemas/SimulatorRoutineInputTimeseries'
            description: Input item for the simulation routine
          type: array
          maxItems: 10000
          title: Inputs
          description: List of input constants and input time series. Used to define the inputs of the simulation routine.
          default: []
        outputs:
          items:
            $ref: '#/components/schemas/SimulatorRoutineOutput'
          type: array
          maxItems: 10000
          title: Outputs
          description: List of outputs for the simulation routine.
          default: []
      additionalProperties: false
      type: object
      required:
      - schedule
      - dataSampling
      - logicalCheck
      - steadyStateDetection
      title: SimulatorRoutineConfiguration
    SimulatorRoutineStepCommand:
      properties:
        order:
          type: integer
          maximum: 10000
          minimum: 1
          title: Order
          description: Step number
        description:
          title: Description
          description: Step description
          type: string
          maxLength: 255
          minLength: 1
        stepType:
          type: string
          const: Command
          title: StepType
          description: Step type
          enum:
          - Command
        arguments:
          $ref: '#/components/schemas/SimulatorRoutineStepArgumentsCommand'
      additionalProperties: false
      type: object
      required:
      - order
      - stepType
      - arguments
      title: SimulatorRoutineStepCommand
      description: Used to run a command in a simulation routine. For example, to run a solver.
    SimulatorRoutineStepGet:
      properties:
        order:
          type: integer
          maximum: 10000
          minimum: 1
          title: Order
          description: Step number
        description:
          title: Description
          description: Step description
          type: string
          maxLength: 255
          minLength: 1
        stepType:
          type: string
          const: Get
          title: StepType
          description: Step type
          enum:
          - Get
        arguments:
          $ref: '#/components/schemas/SimulatorRoutineStepArgumentsGet'
          description: Step arguments
          examples:
          - objectName: WELL.A2
            objectProperty: Tempretature
            referenceId: CWTC
      additionalProperties: false
      type: object
      required:
      - order
      - stepType
      - arguments
      title: SimulatorRoutineStepGet
      description: Used to extract the output of a simulation routine and write it back into the Cognite Data Fusion.
    SingleItemSimulatorRoutineRevisionCreateCommand:
      properties:
        items:
          items:
            $ref: '#/components/schemas/SimulatorRoutineRevisionCreateCommand'
          type: array
          title: Items
          description: A l

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