Rename sample

Rename sample

Sets the file name of the sample. This name does not need to be unique, but it's highly recommended to do so.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/rename

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Body

application/json

name*string

New name for this sample

Example: "faulty-machine2.A3de"

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

Request

JavaScriptCurl

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/rename', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "faulty-machine2.A3de"
    }),
});
const data = await response.json();

Response

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