Dataset Management API
Function¶
Handles basic functions related to Datasets
Filters¶
You can filter the result of each of the calls on this page using the following filters. Filters can be defined either with a close match (==) or with similarity (=like=). All these filters are OPTIONAL.
| Source filter | Value |
|---|---|
| id | Code (ID_TABELLA) of Dataset |
| oid | Code (ID_OWS) of Dataset |
| online | True or False |
| distributedExecution | True or False |
| descriptions | Prefix of the language you wish to filter, followed by the value you wish to filter (ex.descriptions.en=like="ddd") |
| updateInfo.user | Modifier user code |
| updateInfo.origin | DB Modification Mode Code |
| userDataOnly | True or False |
| disableUserRightReadonlyCheck | True or False |
| disableSubmissionChecks | True or False |
| disableProcessConcistencyChecks | True or False |
| disableScenarioPeriodLockingChecks | True or False |
| dataUpdateMode | Determines how changes are stored after values have been changed. The available options are: - CREATE_NEW_RECORD - UPDATE_EXISTING_RECORD |
| partitionPolicy | The partitioning policy guides the logic for creating the physical tables (partitions) where the dataset data is stored. The available options are: - NOT_PARTITIONED - the dataset is not partitioned - BUSINESS_CYCLE - the dataset is broken down by business cycle - BUSINESS_CYCLE_AND_ENTITY - the dataset is partitioned by business cycle and entity |
| dtpProperties.datasetType | Specifies whether the dataset is used as the reference dataset in the dataflow. Immutable - DATASET - REFERENCE_TABLE - DEPLOY_REFERENCE_TABLE - ADVANCED_CONDITION_REFERENCE_TABLE - EXISTENCE_REFERENCE_TABLE |
| status | Dataset status - ONLINE - dataset is online - OFFLINE - dataset is offline - UPGRADE_IN_PROGRESS - the dataset is being updated. The dataset is locked |
| index.field | Index of the dataset (e.g. LABEL) |
| index.indexPosition | Index position (e.g. 0) |
| sort.field | Sorting of the dataset field (e.g. LABEL) |
| sort.sortPosition | Sort order (e.g.: 0) |
| sort.sortType | Dataset order type (e.g. ASC, DESC) |
GET COUNT¶
URL¶
<api-root>/aih/datamodel/v1/<database_id>/workspaces/
Functions¶
- The API returns the number of Datasets in the database.
Request¶
The following parameters are allowed in the request
| Classifier | Required | Value |
|---|---|---|
| DB_ID | Mandatory | ID of the database from which the data are to be extracted |
| workspaces_id | Mandatory | ID of the workspace from which the data are to be extracted |
| filters | Optional | The filters at the top of the page |
Response¶
An integer that corresponds to the number of Datasets, with the required parameters, present in the database.