Start transformation job

Start transformation job

post

Start a transformation job to fetch data from the organization and put it in a project, or transform into new data.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

Path parameters

organizationIdintegerRequired

Organization ID

Body

If uploadType is set to 'project', either projectId, newProjectName or both projectApiKey and projectHmacKey are required. projectId and newProjectName are only available through JWT tokens. If uploadType is set to 'dataset' then outputDatasetName can be set to '' to output in the same dataset, or set to a string to create (or append to) a new dataset.

namestringRequired

filterstringOptional

Filter in SQL format, used for creating transformation jobs on clinical datasets

uploadTypestring · enumOptionalPossible values:

projectIdintegerOptional

projectVisibilitystring · enumOptional

The visibility of the project, either public or private. Public projects can be viewed by anyone on the internet and edited by collaborators. Private projects can only be viewed and edited by collaborators.

Possible values:

newProjectNamestringOptional

projectApiKeystringOptional

projectHmacKeystringOptional

transformationBlockIdintegerOptional

builtinTransformationBlockobjectOptional

categorystring · enumOptionalPossible values:

outputDatasetNamestringOptional

outputDatasetBucketIdintegerOptional

outputDatasetBucketPathstringOptional

Path of new dataset within the bucket; used only when creating a new dataset.

outputPathInDatasetstringOptional

Path within the selected dataset to upload transformed files into. Used only when uploading into a default (non-clinical) dataset.

outputDatasetPathRulestring · enumOptional

Defines the folder structure for writing to the output dataset. Used only when uploading into a default (non-clinical) dataset.

Possible values:

labelstringOptional

emailRecipientUidsinteger[]Optional

transformationParallelintegerOptional

Number of parallel jobs to start

extraCliArgumentsstringOptional

Optional extra arguments for this transformation block

Responses

200

OK

application/json

Responseall of

post

HTTPcURLJavaScriptPython

POST /v1/api/organizations/{organizationId}/create-project HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 596

{
  "name": "text",
  "filter": "text",
  "pathFilters": [
    {
      "dataset": "text",
      "filter": "text"
    }
  ],
  "uploadType": "project",
  "projectId": 1,
  "projectVisibility": "public",
  "newProjectName": "text",
  "projectApiKey": "text",
  "projectHmacKey": "text",
  "transformationBlockId": 1,
  "builtinTransformationBlock": {},
  "category": "training",
  "outputDatasetName": "text",
  "outputDatasetBucketId": 1,
  "outputDatasetBucketPath": "text",
  "outputPathInDataset": "text",
  "outputDatasetPathRule": "no-subfolders",
  "label": "text",
  "emailRecipientUids": [
    1
  ],
  "transformationParallel": 1,
  "extraCliArguments": "text",
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

200

OK

{
  "success": true,
  "error": "text",
  "createProjectId": 1,
  "apiKey": "text"
}