Skip to main content
GET
/
api
/
organizations
/
{organizationId}
/
pipelines
/
archived
List archived pipelines
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines/archived \
  --header 'x-api-key: <api-key>'
import requests

url = "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines/archived"

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}/pipelines/archived', 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}/pipelines/archived",
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}/pipelines/archived"

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}/pipelines/archived")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines/archived")

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,
  "pipelines": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "steps": [
        {
          "name": "<string>",
          "filter": "<string>",
          "pathFilters": [
            {
              "dataset": "<string>",
              "filter": "<string>"
            }
          ],
          "projectId": 123,
          "newProjectName": "<string>",
          "projectApiKey": "<string>",
          "projectHmacKey": "<string>",
          "transformationBlockId": 123,
          "builtinTransformationBlock": {},
          "outputDatasetName": "<string>",
          "outputDatasetBucketId": 123,
          "outputDatasetBucketPath": "<string>",
          "outputPathInDataset": "<string>",
          "label": "<string>",
          "transformationParallel": 123,
          "extraCliArguments": "<string>",
          "parameters": {}
        }
      ],
      "created": "2023-11-07T05:31:56Z",
      "emailRecipientUids": [
        123
      ],
      "intervalStr": "<string>",
      "nextRun": "2023-11-07T05:31:56Z",
      "currentRun": {
        "id": 123,
        "steps": [
          {
            "name": "<string>",
            "transformationJob": {
              "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>",
              "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>"
              }
            },
            "filter": "<string>",
            "projectId": 123,
            "newProjectName": "<string>",
            "projectApiKey": "<string>",
            "projectHmacKey": "<string>",
            "transformationBlockId": 123,
            "builtinTransformationBlock": {},
            "outputDatasetName": "<string>",
            "outputDatasetBucketId": 123,
            "outputDatasetBucketPath": "<string>",
            "label": "<string>",
            "extraCliArguments": "<string>",
            "parameters": {}
          }
        ],
        "created": "2023-11-07T05:31:56Z",
        "finished": "2023-11-07T05:31:56Z",
        "itemCountBefore": {
          "itemCount": 123,
          "itemCountChecklistOK": 123,
          "itemCountChecklistFailed": 123
        },
        "itemCountAfter": {
          "itemCount": 123,
          "itemCountChecklistOK": 123,
          "itemCountChecklistFailed": 123
        },
        "itemCountImportIntoProjectFailed": 123
      },
      "lastRun": {
        "id": 123,
        "steps": [
          {
            "name": "<string>",
            "transformationJob": {
              "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>",
              "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>"
              }
            },
            "filter": "<string>",
            "projectId": 123,
            "newProjectName": "<string>",
            "projectApiKey": "<string>",
            "projectHmacKey": "<string>",
            "transformationBlockId": 123,
            "builtinTransformationBlock": {},
            "outputDatasetName": "<string>",
            "outputDatasetBucketId": 123,
            "outputDatasetBucketPath": "<string>",
            "label": "<string>",
            "extraCliArguments": "<string>",
            "parameters": {}
          }
        ],
        "created": "2023-11-07T05:31:56Z",
        "finished": "2023-11-07T05:31:56Z",
        "itemCountBefore": {
          "itemCount": 123,
          "itemCountChecklistOK": 123,
          "itemCountChecklistFailed": 123
        },
        "itemCountAfter": {
          "itemCount": 123,
          "itemCountChecklistOK": 123,
          "itemCountChecklistFailed": 123
        },
        "itemCountImportIntoProjectFailed": 123
      },
      "feedingIntoDataset": {
        "dataset": "<string>",
        "datasetLink": "<string>",
        "itemCount": 123,
        "itemCountChecklistOK": 123,
        "itemCountChecklistError": 123
      },
      "feedingIntoProject": {
        "id": 123,
        "name": "<string>",
        "projectLink": "<string>",
        "itemCount": 123
      },
      "lastRunStartError": "<string>",
      "notificationWebhook": "<string>"
    }
  ],
  "error": "<string>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

organizationId
integer
required

Organization ID

Query Parameters

projectId
integer

If set, filters on pipelines which are attached to this project.

Response

200 - application/json

OK

success
boolean
required

Whether the operation succeeded

pipelines
object[]
required
error
string

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