Environments-6
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
PATCH | |
DELETE | |
GET | |
POST | |
GET | |
PATCH | |
DELETE |
Retrieve environments dataset items
Required API key scopes
dataset:read
Path parameters
- idstring
A UUID string identifying this dataset item.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Example request
GET
/api /environments /:project_id /dataset_items /:id
Example response
Status 200
Retrieve environments dataset items
Required API key scopes
dataset:read
Path parameters
- idstring
A UUID string identifying this dataset item.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Example request
GET
/api /environments /:project_id /dataset_items /:id
Example response
Status 200
Update environments dataset items
Required API key scopes
dataset:write
Path parameters
- idstring
A UUID string identifying this dataset item.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- datasetstring
- input
- output
- metadata
- ref_trace_idstring
- ref_timestampstring
- ref_source_idstring
- deletedboolean
Response
Example request
PATCH
/api /environments /:project_id /dataset_items /:id
Example response
Status 200
Update environments dataset items
Required API key scopes
dataset:write
Path parameters
- idstring
A UUID string identifying this dataset item.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- datasetstring
- input
- output
- metadata
- ref_trace_idstring
- ref_timestampstring
- ref_source_idstring
- deletedboolean
Response
Example request
PATCH
/api /environments /:project_id /dataset_items /:id
Example response
Status 200
Delete environments dataset items
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
Required API key scopes
dataset:write
Path parameters
- idstring
A UUID string identifying this dataset item.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Example request
DELETE
/api /environments /:project_id /dataset_items /:id
Example response
Status 405 No response body
Delete environments dataset items
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
Required API key scopes
dataset:write
Path parameters
- idstring
A UUID string identifying this dataset item.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Example request
DELETE
/api /environments /:project_id /dataset_items /:id
Example response
Status 405 No response body
List all environments datasets
Required API key scopes
dataset:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- id__inarray
Multiple values may be separated by commas.
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
- order_byarray
Ordering
created_at
- Created At-created_at
- Created At (descending)updated_at
- Updated At-updated_at
- Updated At (descending)
- searchstring
Search in name, description, or metadata
Response
Example request
GET
/api /environments /:project_id /datasets
Example response
Status 200
List all environments datasets
Required API key scopes
dataset:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- id__inarray
Multiple values may be separated by commas.
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
- order_byarray
Ordering
created_at
- Created At-created_at
- Created At (descending)updated_at
- Updated At-updated_at
- Updated At (descending)
- searchstring
Search in name, description, or metadata
Response
Example request
GET
/api /environments /:project_id /datasets
Example response
Status 200
Create environments datasets
Required API key scopes
dataset:write
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- namestring
- descriptionstring
- metadata
- deletedboolean
Response
Example request
POST
/api /environments /:project_id /datasets
Example response
Status 201
Create environments datasets
Required API key scopes
dataset:write
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- namestring
- descriptionstring
- metadata
- deletedboolean
Response
Example request
POST
/api /environments /:project_id /datasets
Example response
Status 201
Retrieve environments datasets
Required API key scopes
dataset:read
Path parameters
- idstring
A UUID string identifying this dataset.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Example request
GET
/api /environments /:project_id /datasets /:id
Example response
Status 200
Retrieve environments datasets
Required API key scopes
dataset:read
Path parameters
- idstring
A UUID string identifying this dataset.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Example request
GET
/api /environments /:project_id /datasets /:id
Example response
Status 200
Update environments datasets
Required API key scopes
dataset:write
Path parameters
- idstring
A UUID string identifying this dataset.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- namestring
- descriptionstring
- metadata
- deletedboolean
Response
Example request
PATCH
/api /environments /:project_id /datasets /:id
Example response
Status 200
Update environments datasets
Required API key scopes
dataset:write
Path parameters
- idstring
A UUID string identifying this dataset.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- namestring
- descriptionstring
- metadata
- deletedboolean
Response
Example request
PATCH
/api /environments /:project_id /datasets /:id
Example response
Status 200
Delete environments datasets
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
Required API key scopes
dataset:write
Path parameters
- idstring
A UUID string identifying this dataset.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Example request
DELETE
/api /environments /:project_id /datasets /:id
Example response
Status 405 No response body
Delete environments datasets
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
Required API key scopes
dataset:write
Path parameters
- idstring
A UUID string identifying this dataset.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Example request
DELETE
/api /environments /:project_id /datasets /:id