150 lines
3.5 KiB
Markdown
150 lines
3.5 KiB
Markdown
---
|
|
name: datasets-routes
|
|
description: Handle 9 OpenAPI operation(s) under /v2/datasets for the datasets route group.
|
|
---
|
|
|
|
# datasets API Routes
|
|
|
|
Handle 9 OpenAPI operation(s) under /v2/datasets for the datasets route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### datasets_get
|
|
|
|
- Operation ID: `datasets_get`
|
|
- Route: `GET /v2/datasets`
|
|
- Mode: READ
|
|
- Summary: Get list of datasets
|
|
- Parameters:
|
|
- `offset` in `query`
|
|
- `limit` in `query`
|
|
- `desc` in `query`
|
|
- `unnamed` in `query`
|
|
- `ownership` in `query`
|
|
|
|
### datasets_post
|
|
|
|
- Operation ID: `datasets_post`
|
|
- Route: `POST /v2/datasets`
|
|
- Mode: WRITE
|
|
- Summary: Create dataset
|
|
- Parameters:
|
|
- `name` in `query`
|
|
|
|
### dataset_get
|
|
|
|
- Operation ID: `dataset_get`
|
|
- Route: `GET /v2/datasets/{datasetId}`
|
|
- Mode: READ
|
|
- Summary: Get dataset
|
|
- Parameters:
|
|
- `datasetId` in `path` required
|
|
|
|
### dataset_put
|
|
|
|
- Operation ID: `dataset_put`
|
|
- Route: `PUT /v2/datasets/{datasetId}`
|
|
- Mode: WRITE
|
|
- Summary: Update dataset
|
|
- Parameters:
|
|
- `datasetId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### dataset_delete
|
|
|
|
- Operation ID: `dataset_delete`
|
|
- Route: `DELETE /v2/datasets/{datasetId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete dataset
|
|
- Parameters:
|
|
- `datasetId` in `path` required
|
|
|
|
### dataset_items_get
|
|
|
|
- Operation ID: `dataset_items_get`
|
|
- Route: `GET /v2/datasets/{datasetId}/items`
|
|
- Mode: READ
|
|
- Summary: Get dataset items
|
|
- Parameters:
|
|
- `datasetId` in `path` required
|
|
- `format` in `query`
|
|
- `clean` in `query`
|
|
- `offset` in `query`
|
|
- `limit` in `query`
|
|
- `fields` in `query`
|
|
- `outputFields` in `query`
|
|
- `omit` in `query`
|
|
- `unwind` in `query`
|
|
- `flatten` in `query`
|
|
- `desc` in `query`
|
|
- `attachment` in `query`
|
|
- `delimiter` in `query`
|
|
- `bom` in `query`
|
|
- `xmlRoot` in `query`
|
|
- `xmlRow` in `query`
|
|
- `skipHeaderRow` in `query`
|
|
- `skipHidden` in `query`
|
|
- `skipEmpty` in `query`
|
|
- `simplified` in `query`
|
|
- `view` in `query`
|
|
- `skipFailedPages` in `query`
|
|
- `feedTitle` in `query`
|
|
- `feedDescription` in `query`
|
|
- `signature` in `query`
|
|
|
|
### dataset_items_head
|
|
|
|
- Operation ID: `dataset_items_head`
|
|
- Route: `HEAD /v2/datasets/{datasetId}/items`
|
|
- Mode: READ
|
|
- Summary: Get dataset items headers
|
|
- Parameters:
|
|
- `datasetId` in `path` required
|
|
- `format` in `query`
|
|
- `clean` in `query`
|
|
- `offset` in `query`
|
|
- `limit` in `query`
|
|
- `fields` in `query`
|
|
- `outputFields` in `query`
|
|
- `omit` in `query`
|
|
- `unwind` in `query`
|
|
- `flatten` in `query`
|
|
- `desc` in `query`
|
|
- `attachment` in `query`
|
|
- `delimiter` in `query`
|
|
- `bom` in `query`
|
|
- `xmlRoot` in `query`
|
|
- `xmlRow` in `query`
|
|
- `skipHeaderRow` in `query`
|
|
- `skipHidden` in `query`
|
|
- `skipEmpty` in `query`
|
|
- `simplified` in `query`
|
|
- `view` in `query`
|
|
- `skipFailedPages` in `query`
|
|
- `feedTitle` in `query`
|
|
- `feedDescription` in `query`
|
|
- `signature` in `query`
|
|
|
|
### dataset_items_post
|
|
|
|
- Operation ID: `dataset_items_post`
|
|
- Route: `POST /v2/datasets/{datasetId}/items`
|
|
- Mode: WRITE
|
|
- Summary: Store items
|
|
- Parameters:
|
|
- `datasetId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### dataset_statistics_get
|
|
|
|
- Operation ID: `dataset_statistics_get`
|
|
- Route: `GET /v2/datasets/{datasetId}/statistics`
|
|
- Mode: READ
|
|
- Summary: Get dataset statistics
|
|
- Parameters:
|
|
- `datasetId` in `path` required
|