White Label Admin - Create a new organization data export

White Label Admin - Create a new organization data export

Create a new data export for an organization. A job is created to process the export request and the job details are returned in the response. This is an API only available to white label admins.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Body

application/json

description*string

Description of the data export

expirationDatestring (date-time)

Date when the export will expire. Default is 30 days. Maximum expiration date is 60 days from the creation date.

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

JavaScriptCurl

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "description": "text"
    }),
});
const data = await response.json();

Response

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