Preview files in a default dataset

Preview files in a default dataset

post

Preview files and directories in a default dataset for the given prefix, with support for wildcards. This is an internal API used when starting a transformation job.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerRequired

Organization ID

datasetstringRequired

Dataset name

Body

prefixstringRequired

S3 prefix

itemsToListstring · enumRequired

Return either files or folders matching the specified prefix

Possible values:

Responses

200

OK

application/json

Responseall of

post

HTTPcURLJavaScriptPython

POST /v1/api/organizations/{organizationId}/dataset/{dataset}/files/preview HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "prefix": "text",
  "itemsToList": "files"
}

200

OK

{
  "success": true,
  "error": "text",
  "files": [
    {
      "name": "text",
      "addedDate": "2019-07-21T17:32:28Z",
      "size": 1,
      "ETag": "text",
      "path": "text",
      "type": "folder"
    }
  ],
  "isTruncated": true,
  "truncationReason": "too-many-results"
}