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>",
"usedFor": "node",
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"isGlobal": true,
"properties": {},
"name": "<string>",
"description": "<string>",
"constraints": {},
"indexes": {}
}
],
"nextCursor": "<string>"
}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.
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>",
"usedFor": "node",
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"isGlobal": true,
"properties": {},
"name": "<string>",
"description": "<string>",
"constraints": {},
"indexes": {}
}
],
"nextCursor": "<string>"
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Query Parameters
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.
1 <= x <= 1000Cursor 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.
"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
The space to query.
1 - 43(?!^(space|cdf|dms|pg3|shared|system|node|edge)$)(^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$)"timeseries"
If the global items of the entity should be returned. Defaults to false which excludes global items.
Only include containers that have been marked as used for the specified purposes. Defaults to [node, edge, all]
Should this operation apply to nodes, edges, records, or both nodes and edges. NB! Currently all applies to nodes and edges, but not records.
node, edge, record, all ["node", "edge", "all", "record"]Was this page helpful?