OrganizationData

Preview files in a default dataset

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.

post/api/organizations/{organizationId}/dataset/{dataset}/files/preview

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/organizations/:organizationId/dataset/:dataset/files/preview/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationIdinteger required

Organization ID

datasetstring required

Dataset name

Request body

prefixstring required

S3 prefix

itemsToList'files' | 'folders' required

Return either files or folders matching the specified prefix

Response

successboolean required

Whether the operation succeeded

errorstring

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

isTruncatedboolean

True if results are truncated.

truncationReason'too-many-results' | 'too-expensive-search'

Explains why results are truncated; only present in the response if isTruncated is true. Results can be truncated if there are too many results (more than 500 matches), or if searching for more results is too expensive (for example, the dataset contains many items but very few match the given wildcard).

Example response

{
  "files": [
    {
      "addedDate": "2019-07-21T17:32:28Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.