OrganizationData

Delete data

Delete all data for selected data items. This removes all data in the underlying data bucket.

post/api/organizations/{organizationId}/data/delete

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/organizations/:organizationId/data/delete/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationIdinteger required

Organization ID

Query parameters

datasetstring

Selected dataset

dataIdsstring required

Data IDs as an Array

filterstring

Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore).

Response

successboolean required

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

idinteger required

Job identifier. Status updates will include this identifier.

Example response

{
  "id": 12873488112
}

Changes

No recorded changes to this operation across all 1 revision of this API.