Get transformation job status
curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId} \
--header 'x-api-key: <api-key>'import requests
url = "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"error": "<string>",
"status": {
"id": 123,
"organizationId": 123,
"name": "<string>",
"created": "2023-11-07T05:31:56Z",
"totalDownloadFileCount": 123,
"totalDownloadFileSize": 123,
"totalDownloadFileSizeString": "<string>",
"totalUploadFileCount": 123,
"transformationParallel": 123,
"transformationSummary": {
"startedCount": 123,
"succeededCount": 123,
"finishedCount": 123,
"totalFileCount": 123,
"totalTimeSpentSeconds": 123
},
"inProgress": true,
"totalTimeSpentSeconds": 123,
"totalTimeSpentString": "<string>",
"files": [
{
"id": 123,
"fileName": "<string>",
"bucketPath": "<string>",
"linkToDataItem": "<string>",
"lengthString": "<string>",
"transformationJobId": 123
}
],
"fileCountForFilter": 123,
"uploadJobId": 123,
"uploadJobFilesUploaded": 123,
"projectOwner": "<string>",
"projectId": 123,
"projectName": "<string>",
"transformationBlockId": 123,
"builtinTransformationBlock": {},
"transformationBlockName": "<string>",
"outputDatasetName": "<string>",
"outputDatasetBucketId": 123,
"outputDatasetBucketPath": "<string>",
"label": "<string>",
"filterQuery": "<string>",
"emailRecipientUids": [
123
],
"pipelineId": 123,
"pipelineName": "<string>",
"pipelineRunId": 123,
"pipelineStep": 123,
"createdByUser": {
"id": 123,
"name": "<string>",
"username": "<string>",
"photo": "<string>"
}
}
}Get transformation job status
Get the current status of a transformation job job.
GET
/
api
/
organizations
/
{organizationId}
/
create-project
/
{createProjectId}
Get transformation job status
curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId} \
--header 'x-api-key: <api-key>'import requests
url = "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/create-project/{createProjectId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"error": "<string>",
"status": {
"id": 123,
"organizationId": 123,
"name": "<string>",
"created": "2023-11-07T05:31:56Z",
"totalDownloadFileCount": 123,
"totalDownloadFileSize": 123,
"totalDownloadFileSizeString": "<string>",
"totalUploadFileCount": 123,
"transformationParallel": 123,
"transformationSummary": {
"startedCount": 123,
"succeededCount": 123,
"finishedCount": 123,
"totalFileCount": 123,
"totalTimeSpentSeconds": 123
},
"inProgress": true,
"totalTimeSpentSeconds": 123,
"totalTimeSpentString": "<string>",
"files": [
{
"id": 123,
"fileName": "<string>",
"bucketPath": "<string>",
"linkToDataItem": "<string>",
"lengthString": "<string>",
"transformationJobId": 123
}
],
"fileCountForFilter": 123,
"uploadJobId": 123,
"uploadJobFilesUploaded": 123,
"projectOwner": "<string>",
"projectId": 123,
"projectName": "<string>",
"transformationBlockId": 123,
"builtinTransformationBlock": {},
"transformationBlockName": "<string>",
"outputDatasetName": "<string>",
"outputDatasetBucketId": 123,
"outputDatasetBucketPath": "<string>",
"label": "<string>",
"filterQuery": "<string>",
"emailRecipientUids": [
123
],
"pipelineId": 123,
"pipelineName": "<string>",
"pipelineRunId": 123,
"pipelineStep": 123,
"createdByUser": {
"id": 123,
"name": "<string>",
"username": "<string>",
"photo": "<string>"
}
}
}Authorizations
ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2
Path Parameters
Organization ID
Create project job ID.
Query Parameters
Maximum number of results of transformation jobs
Offset in results of transformation jobs, can be used in conjunction with TransformLimitResultsParameter to implement paging.
Type of selected rows, either 'all', 'created', 'in-progress' or 'failed' (defaults to 'all')
Was this page helpful?
⌘I