Get pipeline

Get pipeline

Retrieve an organizational pipelines

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

Path parameters

organizationId*integer

Organization ID

pipelineId*integer

Pipeline ID

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

pipeline*OrganizationPipeline (object)

Request

JavaScriptCurl

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

Response

{
  "success": false,
  "error": "text",
  "pipeline": {
    "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-04T18:22:52.206Z",
    "created": "2024-07-04T18:22:52.206Z",
    "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-04T18:22:52.206Z",
            "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-04T18:22:52.206Z",
      "finished": "2024-07-04T18:22:52.206Z",
      "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-04T18:22:52.206Z",
            "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-04T18:22:52.206Z",
      "finished": "2024-07-04T18:22:52.206Z",
      "itemCountBefore": {},
      "itemCountAfter": {}
    },
    "feedingIntoDataset": {
      "dataset": "text",
      "datasetLink": "text"
    },
    "feedingIntoProject": {
      "name": "text",
      "projectLink": "text"
    },
    "emailRecipientUids": [],
    "lastRunStartError": "text",
    "notificationWebhook": "text",
    "whenToEmail": "always"
  }
}