Disable multiple samples

Disable multiple samples

post

Disables samples, ensuring that they are excluded from the dataset. Depending on the number of affected samples this will either execute immediately or return the ID of a job that will perform this action in batches.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerRequired

Project ID

Query parameters

categorystring · enumRequired

Which of the three acquisition categories to retrieve data from

Possible values:

labelsstringOptional

Only include samples with a label within the given list of labels, given as a JSON string

Example: ["idle", "snake"]

filenamestringOptional

Only include samples whose filename includes the given filename

maxLengthintegerOptional

Only include samples shorter than the given length, in milliseconds

minLengthintegerOptional

Only include samples longer than the given length, in milliseconds

minFrequencynumberOptional

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumberOptional

Only include samples with lower frequency than given frequency, in hertz

signatureValiditystring · enumOptional

Include samples with either valid or invalid signatures

Possible values:

includeDisabledstring · enumOptional

Include only enabled or disabled samples (or both)

Possible values:

idsstringOptional

Only include samples with an ID within the given list of IDs, given as a JSON string

Example: [1, 2, 3]

excludeIdsstringOptional

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example: [4, 5, 6]

minLabelnumberOptional

Only include samples with a label >= this value

maxLabelnumberOptional

Only include samples with a label < this value

searchstringOptional

Search query

Example: <id> <name>

Responses

Responseany of

or

all ofOptional

post

HTTPcURLJavaScriptPython

POST /v1/api/{projectId}/raw-data/batch/disable-samples HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "error": "text"
}