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.

post

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

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerrequired

Project ID

sampleIdintegerrequired

Sample ID

Body

namestringrequired

New name for this sample

Example: faulty-machine2.A3de

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

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

OK