cloudsprite.datasets¶
Datasets in the default project (requires set_project).
Module convenience alias for Client.datasets (process-default client). Not listed in __all__.
Signature¶
@property
cs.datasets -> ResourceCollection[Dataset]
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
include_imagefile |
query |
boolean |
no | false |
include_instruments |
query |
boolean |
no | false |
include_parameters |
query |
boolean |
no | false |
limit |
query |
integer |
no | 100 |
offset |
query |
integer |
no | 0 |
ordering |
query |
string |
no | - |
project_id |
query |
string |
yes | - |
q |
query |
string |
no | - |
source_type |
query |
string |
no | - |
Return shape¶
HTTP 200 — OK
Schema: PagedDatasetSchema
| Field | Type | Required |
|---|---|---|
count |
integer |
yes |
items |
array<DatasetSchema> |
yes |
Permission¶
Required permission: dataset:read
HTTP¶
GET /api/datasets/ (listDatasets)
Usage¶
cs.datasets