Simulator Models

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.

Create Simulator Model

Create a simulator model.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
required
Array of objects (Items)

A list with a single item

Responses
201

Successful Response

400

Bad Request

403

Forbidden

500

Internal Server Error

post/simulators/models
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Filter Simulator Models

Retrieves a list of simulator models that match the given criteria.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
object (ListSimulatorModelsFilters)
limit
integer (Limit) [ 1 .. 1000 ]
Default: 1000
cursor
string (Cursor)

Cursor for pagination

Array of objects (Sort)

Only supports sorting by one property at a time

Responses
200

Successful Response

400

Bad Request

403

Forbidden

500

Internal Server Error

post/simulators/models/list
Request samples
application/json
{
  • "filter": {
    },
  • "limit": 1000,
  • "cursor": "string",
  • "sort": [
    ]
}
Response samples
application/json
{
  • "items": [
    ],
  • "nextCursor": "string"
}

Aggregate Simulator Models

Calculate aggregates for simulator models, considering the optional filter specification.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
object (ListSimulatorModelsFilters)
aggregate
required
string (Aggregate)

Aggregate type

Value: "count"
Value: "count"
Responses
200

Successful Response

400

Bad Request

403

Forbidden

500

Internal Server Error

post/simulators/models/aggregate
Request samples
application/json
{
  • "filter": {
    },
  • "aggregate": "count"
}
Response samples
application/json
{
  • "items": [
    ]
}

Delete Simulator Model

Delete a simulator model. This will also delete all associated simulator resources (e.g. revisions, routines, runs).

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
required
Array of IdRef (object) or ExternalIdRef (object) (Items)

A list with a single item

Responses
200

Successful Response

403

Forbidden

500

Internal Server Error

post/simulators/models/delete
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{ }

Update Simulator Model

Update a simulator model.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
required
Array of objects (Items)

A list with a single item

Responses
200

Successful Response

400

Bad Request

403

Forbidden

500

Internal Server Error

post/simulators/models/update
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Retrieve Simulator Model

Retrieve a simulator model by ID or external ID.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
required
Array of IdRef (object) or ExternalIdRef (object) (Items)

A list with a single item

Responses
200

Successful Response

400

Bad Request

403

Forbidden

500

Internal Server Error

post/simulators/models/byids
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Create Simulator Model Revision

Create a simulator model revision.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
required
Array of objects (Items)

A list with a single item

deleteOldest
boolean (DeleteOldest)
Default: false

When true, deletes the oldest revisions for the model, keeping only the newest revisions up to the per model limit.

Responses
201

Successful Response

400

Bad Request

403

Forbidden

500

Internal Server Error

post/simulators/models/revisions
Request samples
application/json
{
  • "items": [
    ],
  • "deleteOldest": false
}
Response samples
application/json
{
  • "items": [
    ]
}

Filter Simulator Model Revisions

Retrieves a list of simulator model revisions that match the given criteria.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
object (ListSimulatorModelRevisionsFilters)
limit
integer (Limit) [ 1 .. 1000 ]
Default: 1000
cursor
string (Cursor)

Cursor for pagination

Array of objects (Sort)

Only supports sorting by one property at a time

Responses
200

Successful Response

400

Bad Request

403

Forbidden

500

Internal Server Error

post/simulators/models/revisions/list
Request samples
application/json
{
  • "filter": {
    },
  • "limit": 1000,
  • "cursor": "string",
  • "sort": [
    ]
}
Response samples
application/json
{
  • "items": [
    ],
  • "nextCursor": "string"
}

Retrieve Simulator Model Revisions

Retrieve one or more simulator model revisions by IDs or external IDs.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
required
Array of IdRef (object) or ExternalIdRef (object) (Items) [ 1 .. 100 ] items

A list of items

Responses
200

Successful Response

400

Bad Request

403

Forbidden

500

Internal Server Error

post/simulators/models/revisions/byids
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}
➔ Next to Simulator Routines