data_model_list = client.data_modeling.data_models.list(limit=5)
for data_model in client.data_modeling.data_models:
data_model # do something with the data_model
for data_model_list in client.data_modeling.data_models(chunk_size=10):
data_model_list # do something with the data model{
"items": [
{
"space": "<string>",
"externalId": "<string>",
"version": "<string>",
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"isGlobal": true,
"name": "<string>",
"description": "<string>",
"views": [
{
"type": "view",
"space": "<string>",
"externalId": "<string>",
"version": "<string>"
}
]
}
],
"nextCursor": "<string>"
}List data models defined in the project
Required capabilities:
DataModelsAcl:READ
List data models defined in the project. You can filter the returned models by the specified space.
data_model_list = client.data_modeling.data_models.list(limit=5)
for data_model in client.data_modeling.data_models:
data_model # do something with the data_model
for data_model_list in client.data_modeling.data_models(chunk_size=10):
data_model_list # do something with the data model{
"items": [
{
"space": "<string>",
"externalId": "<string>",
"version": "<string>",
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"isGlobal": true,
"name": "<string>",
"description": "<string>",
"views": [
{
"type": "view",
"space": "<string>",
"externalId": "<string>",
"version": "<string>"
}
]
}
],
"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"
Should we expand the referenced views inline in the returned result.
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 all versions of the entity should be returned. Defaults to false which returns the latest version, attributed to the newest 'createdTime' field
If the global items of the entity should be returned. Defaults to false which excludes global items.
Was this page helpful?