List of containers defined in the current project. You can filter the list by specifying a space.
List of containers
The response for a failed request.
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
{- "items": [
- {
- "space": "string",
- "externalId": "string",
- "name": "string",
- "description": "string",
- "usedFor": "node",
- "properties": {
- "containerPropertyIdentifier1": {
- "immutable": false,
- "nullable": true,
- "autoIncrement": false,
- "defaultValue": "string",
- "description": "string",
- "name": "string",
- "type": {
- "type": "text",
- "list": false,
- "collation": "ucs_basic"
}
}, - "containerPropertyIdentifier2": {
- "immutable": false,
- "nullable": true,
- "autoIncrement": false,
- "defaultValue": "string",
- "description": "string",
- "name": "string",
- "type": {
- "type": "text",
- "list": false,
- "collation": "ucs_basic"
}
}
}, - "constraints": {
- "constraint-identifier1": {
- "constraintType": "requires",
- "require": {
- "type": "container",
- "space": "string",
- "externalId": "string"
}
}, - "constraint-identifier2": {
- "constraintType": "requires",
- "require": {
- "type": "container",
- "space": "string",
- "externalId": "string"
}
}
}, - "indexes": {
- "index-identifier1": {
- "properties": [
- "string"
], - "indexType": "btree",
- "cursorable": false,
- "bySpace": false
}, - "index-identifier2": {
- "properties": [
- "string"
], - "indexType": "btree",
- "cursorable": false,
- "bySpace": false
}
}, - "createdTime": 1730204346000,
- "lastUpdatedTime": 1730204346000,
- "isGlobal": true
}
], - "nextCursor": "string"
}