Containers

Create or update containers

Required capabilities: dataModelsAcl:WRITE

Add or update (upsert) containers. For unchanged container specifications, the operation completes without making any changes. We will not update the lastUpdatedTime value for containers that remain unchanged.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

Containers to add or update.

required
Array of Instance Container (object) or Record Container (object) (ContainerCreateDefinition) [ 1 .. 100 ] items

List of containers to create/update

Responses
200

List of containers

400

The response for a failed request.

409

View conflict

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

List containers defined in the project

Required capabilities: dataModelsAcl:READ

List of containers defined in the current project. You can filter the list by specifying a space.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 10

Limit the number of results returned. The largest result-set returned by the server will be 1000 items, even if you specify a higher limit.

cursor
string

Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that value as the cursor parameter in the next request.

Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.

Example: cursor=4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo
space
string [ 1 .. 43 ] characters (?!^(space|cdf|dms|pg3|shared|system|node|edg...

The space to query.

Example: space=timeseries
includeGlobal
boolean
Default: false

If the global items of the entity should be returned. Defaults to false which excludes global items.

usedFor
Array of strings (UsedFor) unique

Only include entities that have been marked as used for the specified purposes. Defaults to [node, edge, all]

Items Enum: "node" "edge" "record" "all"
Example: usedFor=node&usedFor=edge&usedFor=all&usedFor=record
Responses
200

List of containers

400

The response for a failed request.

get/models/containers
Request samples 
container_list = client.data_modeling.containers.list(limit=5)

for container in client.data_modeling.containers:
    container # do something with the container

for container_list in client.data_modeling.containers(chunk_size=10):
    container_list # do something with the containers
Response samples
application/json
{
  • "items": [
    ],
  • "nextCursor": "string"
}

Retrieve containers by their external ids

Required capabilities: dataModelsAcl:READ

Retrieve up to 100 containers by their specified external ids.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

List of external-ids of containers to retrieve.

required
Array of objects [ 1 .. 100 ] items
Responses
200

List of containers

400

The response for a failed request.

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

Delete containers

Required capabilities: dataModelsAcl:WRITE

Delete one or more containers. Currently limited to 100 containers at a time.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

List of spaces and external-ids for the containers you want to delete.

required
Array of objects [ 1 .. 100 ] items
Responses
200

List of External id(s) for the affected items

400

The response for a failed request.

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

Delete indexes from containers

Required capabilities: dataModelsAcl:WRITE

Delete one or more container indexes. Currently limited to 10 indexes at a time.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

List of references to the indexes you want to delete.

required
Array of objects (ContainerSubObjectIdentifier) [ 1 .. 10 ] items
Responses
200

List of External id(s) for the affected items

400

The response for a failed request.

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

Retry failed indexes

Required capabilities: dataModelsAcl:WRITE

Triggers a retry of the given failed container indexes. This will usually entail scanning through all the data in the container, so use this sparingly. There are strict limits as to how often a given index can be retried, and how many schema entities can be in a retrying state simultaneously.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

List of references to the indexes you want to retry.

required
Array of objects (ContainerSubObjectIdentifier) [ 1 .. 10 ] items
Responses
200

List of External id(s) for the affected items

400

The response for a failed request.

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

Delete constraints from containers

Required capabilities: dataModelsAcl:WRITE

Delete one or more container constraints. Currently limited to 10 constraints at a time.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

List of references to the constraints you want to delete.

required
Array of objects (ContainerSubObjectIdentifier) [ 1 .. 10 ] items
Responses
200

List of External id(s) for the affected items

400

The response for a failed request.

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

Retry failed container constraints

Required capabilities: dataModelsAcl:WRITE

Triggers a revalidation of the given failed container constraints. This will usually entail scanning through all the data in the container, so use this sparingly. There are strict limits as to how often a given constraint can be revalidated, and how many schema entities can be in a retrying state simultaneously.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

List of references to the constraints you want to retry.

required
Array of objects (ContainerSubObjectIdentifier) [ 1 .. 10 ] items
Responses
200

List of External id(s) for the affected items

400

The response for a failed request.

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

Retry failed property constraints

Required capabilities: dataModelsAcl:WRITE

Triggers a revalidation of failed constraints on the given properties. This includes nullable, maxListSize and maxTextSize. Revalidation usually entails scanning through all the data in the container, so use this sparingly. There are strict limits as to how often a given property can be revalidated, and how many schema entities can be in a retrying simultaneously.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

List of references to properties with property-level constraints that you want to retry.

required
Array of objects (ContainerSubObjectIdentifier) [ 1 .. 10 ] items
Responses
200

List of External id(s) for the affected items

400

The response for a failed request.

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

Inspect containers

Required capabilities: dataModelsAcl:READ

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

Which containers to inspect and the inspection operations to run.

required
object
required
Array of objects [ 1 .. 10 ] items
Responses
200

Containers along with the results of the inspection operations

400

The response for a failed request.

post/models/containers/inspect
Request samples
application/json
{
  • "inspectionOperations": {
    },
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}
➔ Next to Instances