List spaces defined in the project

List spaces defined in the current project.

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
includeGlobal
boolean
Default: false

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

Responses
200

List of spaces

400

The response for a failed request.

get/models/spaces
Request samples
space_list = client.data_modeling.spaces.list(limit=5)

for space in client.data_modeling.spaces:
    space # do something with the space

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