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.

POST /api/{projectId}/raw-data/{sampleId}/rename

Rename sample

cURL

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/rename \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "faulty-machine2.A3de"
}
'

200

{
  "success": true,
  "error": "<string>"
}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

sampleId · integer · required

Sample ID

Body

application/json

name · string · required

New name for this sample

Example:

"faulty-machine2.A3de"

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

error · string

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