List pipelines

List pipelines

Retrieve all organizational pipelines

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines

Path parameters

organizationId*integer

Organization ID

Query parameters

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

pipelines*array of OrganizationPipeline (object)

Request

JavaScriptCurl

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "pipelines": [
    {
      "name": "text",
      "description": "text",
      "intervalStr": "text",
      "steps": [
        {
          "name": "text",
          "filter": "text",
          "pathFilters": [
            {
              "dataset": "text",
              "filter": "text"
            }
          ],
          "uploadType": "project",
          "newProjectName": "text",
          "projectApiKey": "text",
          "projectHmacKey": "text",
          "category": "training",
          "outputDatasetName": "text",
          "outputDatasetBucketPath": "text",
          "outputPathInDataset": "text",
          "outputDatasetPathRule": "no-subfolders",
          "label": "text",
          "extraCliArguments": "text"
        }
      ],
      "nextRun": "2024-07-04T17:59:29.267Z",
      "created": "2024-07-04T17:59:29.267Z",
      "currentRun": {
        "steps": [
          {
            "name": "text",
            "transformationJob": {
              "name": "text",
              "uploadType": "dataset",
              "status": "waiting",
              "transformJobStatus": "waiting",
              "uploadJobStatus": "waiting",
              "projectOwner": "text",
              "projectName": "text",
              "transformationBlockName": "text",
              "category": "training",
              "created": "2024-07-04T17:59:29.267Z",
              "outputDatasetName": "text",
              "outputDatasetBucketPath": "text",
              "totalDownloadFileSizeString": "text",
              "transformationSummary": {},
              "inProgress": false,
              "label": "text",
              "filterQuery": "text",
              "emailRecipientUids": [],
              "pipelineName": "text",
              "operatesOn": "file",
              "totalTimeSpentString": "text",
              "createdByUser": {
                "name": "text",
                "username": "text",
                "photo": "text"
              }
            },
            "filter": "text",
            "uploadType": "project",
            "newProjectName": "text",
            "projectApiKey": "text",
            "projectHmacKey": "text",
            "category": "training",
            "outputDatasetName": "text",
            "outputDatasetBucketPath": "text",
            "label": "text",
            "extraCliArguments": "text"
          }
        ],
        "created": "2024-07-04T17:59:29.267Z",
        "finished": "2024-07-04T17:59:29.267Z",
        "itemCountBefore": {},
        "itemCountAfter": {}
      },
      "lastRun": {
        "steps": [
          {
            "name": "text",
            "transformationJob": {
              "name": "text",
              "uploadType": "dataset",
              "status": "waiting",
              "transformJobStatus": "waiting",
              "uploadJobStatus": "waiting",
              "projectOwner": "text",
              "projectName": "text",
              "transformationBlockName": "text",
              "category": "training",
              "created": "2024-07-04T17:59:29.267Z",
              "outputDatasetName": "text",
              "outputDatasetBucketPath": "text",
              "totalDownloadFileSizeString": "text",
              "transformationSummary": {},
              "inProgress": false,
              "label": "text",
              "filterQuery": "text",
              "emailRecipientUids": [],
              "pipelineName": "text",
              "operatesOn": "file",
              "totalTimeSpentString": "text",
              "createdByUser": {
                "name": "text",
                "username": "text",
                "photo": "text"
              }
            },
            "filter": "text",
            "uploadType": "project",
            "newProjectName": "text",
            "projectApiKey": "text",
            "projectHmacKey": "text",
            "category": "training",
            "outputDatasetName": "text",
            "outputDatasetBucketPath": "text",
            "label": "text",
            "extraCliArguments": "text"
          }
        ],
        "created": "2024-07-04T17:59:29.267Z",
        "finished": "2024-07-04T17:59:29.267Z",
        "itemCountBefore": {},
        "itemCountAfter": {}
      },
      "feedingIntoDataset": {
        "dataset": "text",
        "datasetLink": "text"
      },
      "feedingIntoProject": {
        "name": "text",
        "projectLink": "text"
      },
      "emailRecipientUids": [],
      "lastRunStartError": "text",
      "notificationWebhook": "text",
      "whenToEmail": "always"
    }
  ]
}