Create, infer, validate, browse, update, and delete datasets.
Overview
Create, infer, validate, browse, update, and delete datasets. API clients must be tenant-aware, permission-aware, and capable of handling both JSON and binary responses.
Key points
- POST and PUT save dataset metadata and JSON.
- GET lists or retrieves datasets.
- GET tree returns schema and root path.
- POST validate parses stored JSON.
- POST infer builds a field tree from sample data.
- Deleting a dataset requires review of dependent templates and mappings.
Endpoints
| Method | Route | Purpose |
|---|---|---|
| POST | /api/v1/datasets | Create a dataset. |
| GET | /api/v1/datasets | List datasets. |
| GET | /api/v1/datasets/i/{uuid} | Retrieve a dataset. |
| PUT | /api/v1/datasets/i/{uuid} | Update a dataset. |
| DELETE | /api/v1/datasets/i/{uuid} | Delete a dataset. |
| GET | /api/v1/datasets/i/{uuid}/tree | Retrieve the stored data tree. |
| POST | /api/v1/datasets/i/{uuid}/validate | Validate stored JSON. |
| POST | /api/v1/datasets/i/{uuid}/infer | Infer a tree from sample data. |
Recommended procedure
- Send authentication and instance headers.
- Validate the request body before transmission.
- Inspect HTTP status, content type, and structured errors.
- Log non-sensitive identifiers needed to reproduce failures.
Client requirements
- Check the HTTP status before processing the body.
- Check
Content-Typebefore deciding whether the response is JSON, DOCX, or PDF. - Do not log authentication tokens or complete client document data.
- Preserve the instance context through every Feradel service-to-service call.
- Treat validation and compilation errors as input or template defects rather than transient network failures.
Troubleshooting
A client treats an error as a file
Check HTTP status and Content-Type before writing the response body to disk.
The same request works in another tenant
Compare instance, owner, token permissions, and object UUIDs.
A route returns an unexpected envelope
The current controllers are not fully standardized; handle HTTP status and documented fields defensively.
Related documentation
Documentation source: feradelinc/feradel.render.api, reviewed against repository revision b2c3a710. Verify behavior against the deployed release before publishing exact routes, limits, or version requirements.