GET
/
api
/
organizations
/
{organizationId}
/
pipelines
/
{pipelineId}
Get pipeline
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines/{pipelineId} \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "error": "<string>",
  "pipeline": {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "intervalStr": "<string>",
    "steps": [
      {
        "name": "<string>",
        "filter": "<string>",
        "pathFilters": [
          {
            "dataset": "<string>",
            "filter": "<string>"
          }
        ],
        "uploadType": "project",
        "projectId": 123,
        "newProjectName": "<string>",
        "projectApiKey": "<string>",
        "projectHmacKey": "<string>",
        "transformationBlockId": 123,
        "builtinTransformationBlock": {},
        "category": "training",
        "outputDatasetName": "<string>",
        "outputDatasetBucketId": 123,
        "outputDatasetBucketPath": "<string>",
        "outputPathInDataset": "<string>",
        "outputDatasetPathRule": "no-subfolders",
        "label": "<string>",
        "transformationParallel": 123,
        "extraCliArguments": "<string>",
        "parameters": {}
      }
    ],
    "nextRun": "2023-11-07T05:31:56Z",
    "created": "2023-11-07T05:31:56Z",
    "currentRun": {
      "id": 123,
      "steps": [
        {
          "name": "<string>",
          "transformationJob": {
            "id": 123,
            "organizationId": 123,
            "name": "<string>",
            "uploadType": "dataset",
            "status": "waiting",
            "transformJobStatus": "waiting",
            "uploadJobId": 123,
            "uploadJobStatus": "waiting",
            "uploadJobFilesUploaded": 123,
            "projectOwner": "<string>",
            "projectId": 123,
            "projectName": "<string>",
            "transformationBlockId": 123,
            "builtinTransformationBlock": {},
            "transformationBlockName": "<string>",
            "category": "training",
            "created": "2023-11-07T05:31:56Z",
            "outputDatasetName": "<string>",
            "outputDatasetBucketId": 123,
            "outputDatasetBucketPath": "<string>",
            "totalDownloadFileCount": 123,
            "totalDownloadFileSize": 123,
            "totalDownloadFileSizeString": "<string>",
            "totalUploadFileCount": 123,
            "transformationParallel": 123,
            "transformationSummary": {
              "startedCount": 123,
              "succeededCount": 123,
              "finishedCount": 123,
              "totalFileCount": 123,
              "totalTimeSpentSeconds": 123
            },
            "inProgress": true,
            "label": "<string>",
            "filterQuery": "<string>",
            "emailRecipientUids": [
              123
            ],
            "pipelineId": 123,
            "pipelineName": "<string>",
            "pipelineRunId": 123,
            "pipelineStep": 123,
            "operatesOn": "file",
            "totalTimeSpentSeconds": 123,
            "totalTimeSpentString": "<string>",
            "createdByUser": {
              "id": 123,
              "name": "<string>",
              "username": "<string>",
              "photo": "<string>"
            }
          },
          "filter": "<string>",
          "uploadType": "project",
          "projectId": 123,
          "newProjectName": "<string>",
          "projectApiKey": "<string>",
          "projectHmacKey": "<string>",
          "transformationBlockId": 123,
          "builtinTransformationBlock": {},
          "category": "training",
          "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>",
            "uploadType": "dataset",
            "status": "waiting",
            "transformJobStatus": "waiting",
            "uploadJobId": 123,
            "uploadJobStatus": "waiting",
            "uploadJobFilesUploaded": 123,
            "projectOwner": "<string>",
            "projectId": 123,
            "projectName": "<string>",
            "transformationBlockId": 123,
            "builtinTransformationBlock": {},
            "transformationBlockName": "<string>",
            "category": "training",
            "created": "2023-11-07T05:31:56Z",
            "outputDatasetName": "<string>",
            "outputDatasetBucketId": 123,
            "outputDatasetBucketPath": "<string>",
            "totalDownloadFileCount": 123,
            "totalDownloadFileSize": 123,
            "totalDownloadFileSizeString": "<string>",
            "totalUploadFileCount": 123,
            "transformationParallel": 123,
            "transformationSummary": {
              "startedCount": 123,
              "succeededCount": 123,
              "finishedCount": 123,
              "totalFileCount": 123,
              "totalTimeSpentSeconds": 123
            },
            "inProgress": true,
            "label": "<string>",
            "filterQuery": "<string>",
            "emailRecipientUids": [
              123
            ],
            "pipelineId": 123,
            "pipelineName": "<string>",
            "pipelineRunId": 123,
            "pipelineStep": 123,
            "operatesOn": "file",
            "totalTimeSpentSeconds": 123,
            "totalTimeSpentString": "<string>",
            "createdByUser": {
              "id": 123,
              "name": "<string>",
              "username": "<string>",
              "photo": "<string>"
            }
          },
          "filter": "<string>",
          "uploadType": "project",
          "projectId": 123,
          "newProjectName": "<string>",
          "projectApiKey": "<string>",
          "projectHmacKey": "<string>",
          "transformationBlockId": 123,
          "builtinTransformationBlock": {},
          "category": "training",
          "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,
      "datasetType": "clinical"
    },
    "feedingIntoProject": {
      "id": 123,
      "name": "<string>",
      "projectLink": "<string>",
      "itemCount": 123
    },
    "emailRecipientUids": [
      123
    ],
    "lastRunStartError": "<string>",
    "notificationWebhook": "<string>",
    "whenToEmail": "always"
  }
}

Authorizations

x-api-key
string
header
required

Path Parameters

organizationId
integer
required

Organization ID

pipelineId
integer
required

Pipeline ID

Response

200 - application/json

OK

The response is of type object.