List archived pipelines

Retrieve all archived organizational pipelines

GET /api/organizations/{organizationId}/pipelines/archived

Try it

List archived pipelines

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/pipelines/archived \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "pipelines": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<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": {}
        }
      ],
      "created": "2023-11-07T05:31:56Z",
      "emailRecipientUids": [
        123
      ],
      "whenToEmail": "always",
      "intervalStr": "<string>",
      "nextRun": "2023-11-07T05:31:56Z",
      "currentRun": {
        "id": 123,
        "steps": [
          {
            "name": "<string>",
            "transformationJob": {
              "id": 123,
              "organizationId": 123,
              "name": "<string>",
              "uploadType": "dataset",
              "status": "waiting",
              "transformJobStatus": "waiting",
              "uploadJobStatus": "waiting",
              "category": "training",
              "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,
              "operatesOn": "file",
              "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>",
            "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",
              "uploadJobStatus": "waiting",
              "category": "training",
              "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,
              "operatesOn": "file",
              "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>",
            "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
      },
      "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

Show child attributes

pipelines. id · integer · required

pipelines. name · string · required

pipelines. description · string · required

pipelines. steps · object[] · required

Show child attributes

pipelines.steps. name · string · required

pipelines.steps. filter · string

pipelines.steps. pathFilters · object[]

Set of paths to apply the transformation to, used for creating transformation jobs on default datasets. This option is experimental and may change in the future.

Show child attributes

pipelines.steps.pathFilters. dataset · string · required

Dataset name of files to transform

pipelines.steps.pathFilters. filter · string · required

Path filter with wildcards, relative to the root of the dataset. For example, /folder/*.json will transform all JSON files in /folder (when operating on files)

pipelines.steps. uploadType · enum<string>

Available options: project, dataset

pipelines.steps. projectId · integer

pipelines.steps. newProjectName · string

pipelines.steps. projectApiKey · string

pipelines.steps. projectHmacKey · string

pipelines.steps. transformationBlockId · integer

pipelines.steps. builtinTransformationBlock · object

pipelines.steps. category · enum<string>

Available options: training, testing, split

pipelines.steps. outputDatasetName · string

pipelines.steps. outputDatasetBucketId · integer

pipelines.steps. outputDatasetBucketPath · string

pipelines.steps. outputPathInDataset · string

Path within the selected dataset to upload transformed files into. Used only when uploading into a default (non-clinical) dataset.

pipelines.steps. outputDatasetPathRule · enum<string>

Defines the folder structure for writing to the output dataset. Used only when uploading into a default (non-clinical) dataset.

Available options: no-subfolders, subfolder-per-item, use-full-path

pipelines.steps. label · string

pipelines.steps. transformationParallel · integer

pipelines.steps. extraCliArguments · string

pipelines.steps. parameters · object

Show child attributes

pipelines.steps.parameters. {key} · string

pipelines. created · string<date-time> · required

pipelines. emailRecipientUids · integer[] · required

pipelines. whenToEmail · enum<string> · required

Available options: always, on_new_data, never

pipelines. intervalStr · string

15m for every 15 minutes, 2h for every 2 hours, 1d for every 1 day

pipelines. nextRun · string<date-time>

pipelines. currentRun · object

Show child attributes

pipelines.currentRun. id · integer · required

pipelines.currentRun. steps · object[] · required

Show child attributes

pipelines.currentRun.steps. name · string · required

pipelines.currentRun.steps. transformationJob · object

Show child attributes

pipelines.currentRun.steps.transformationJob. id · integer · required

pipelines.currentRun.steps.transformationJob. organizationId · integer · required

pipelines.currentRun.steps.transformationJob. name · string · required

pipelines.currentRun.steps.transformationJob. uploadType · enum<string> · required

Available options: dataset, project

pipelines.currentRun.steps.transformationJob. status · enum<string> · required

Available options: waiting, created, started, finished, failed

pipelines.currentRun.steps.transformationJob. transformJobStatus · enum<string> · required

Available options: waiting, created, started, finished, failed

pipelines.currentRun.steps.transformationJob. uploadJobStatus · enum<string> · required

Available options: waiting, created, started, finished, failed

pipelines.currentRun.steps.transformationJob. category · enum<string> · required

Available options: training, testing, split

pipelines.currentRun.steps.transformationJob. created · string<date-time> · required

pipelines.currentRun.steps.transformationJob. totalDownloadFileCount · integer · required

pipelines.currentRun.steps.transformationJob. totalDownloadFileSize · integer · required

pipelines.currentRun.steps.transformationJob. totalDownloadFileSizeString · string · required

pipelines.currentRun.steps.transformationJob. totalUploadFileCount · integer · required

pipelines.currentRun.steps.transformationJob. transformationParallel · integer · required

Number of transformation jobs that can be ran in parallel

pipelines.currentRun.steps.transformationJob. transformationSummary · object · required

Show child attributes

pipelines.currentRun.steps.transformationJob.transformationSummary. startedCount · integer · required

pipelines.currentRun.steps.transformationJob.transformationSummary. succeededCount · integer · required

pipelines.currentRun.steps.transformationJob.transformationSummary. finishedCount · integer · required

pipelines.currentRun.steps.transformationJob.transformationSummary. totalFileCount · integer · required

pipelines.currentRun.steps.transformationJob.transformationSummary. totalTimeSpentSeconds · integer · required

Total amount of compute used for this job (in seconds)

pipelines.currentRun.steps.transformationJob. inProgress · boolean · required

pipelines.currentRun.steps.transformationJob. operatesOn · enum<string> · required

Available options: file, directory, standalone

pipelines.currentRun.steps.transformationJob. totalTimeSpentSeconds · integer · required

Total amount of compute used for this job (in seconds)

pipelines.currentRun.steps.transformationJob. totalTimeSpentString · string · required

Total amount of compute used (friendly string)

pipelines.currentRun.steps.transformationJob. uploadJobId · integer

pipelines.currentRun.steps.transformationJob. uploadJobFilesUploaded · integer

pipelines.currentRun.steps.transformationJob. projectOwner · string

pipelines.currentRun.steps.transformationJob. projectId · integer

pipelines.currentRun.steps.transformationJob. projectName · string

pipelines.currentRun.steps.transformationJob. transformationBlockId · integer

pipelines.currentRun.steps.transformationJob. builtinTransformationBlock · object

pipelines.currentRun.steps.transformationJob. transformationBlockName · string

pipelines.currentRun.steps.transformationJob. outputDatasetName · string

pipelines.currentRun.steps.transformationJob. outputDatasetBucketId · integer

pipelines.currentRun.steps.transformationJob. outputDatasetBucketPath · string

pipelines.currentRun.steps.transformationJob. label · string

pipelines.currentRun.steps.transformationJob. filterQuery · string

pipelines.currentRun.steps.transformationJob. emailRecipientUids · integer[]

pipelines.currentRun.steps.transformationJob. pipelineId · integer

pipelines.currentRun.steps.transformationJob. pipelineName · string

pipelines.currentRun.steps.transformationJob. pipelineRunId · integer

pipelines.currentRun.steps.transformationJob. pipelineStep · integer

pipelines.currentRun.steps.transformationJob. createdByUser · object

Show child attributes

pipelines.currentRun.steps.transformationJob.createdByUser. id · integer · required

pipelines.currentRun.steps.transformationJob.createdByUser. name · string · required

pipelines.currentRun.steps.transformationJob.createdByUser. username · string · required

pipelines.currentRun.steps.transformationJob.createdByUser. photo · string

pipelines.currentRun.steps. filter · string

pipelines.currentRun.steps. uploadType · enum<string>

Available options: project, dataset

pipelines.currentRun.steps. projectId · integer

pipelines.currentRun.steps. newProjectName · string

pipelines.currentRun.steps. projectApiKey · string

pipelines.currentRun.steps. projectHmacKey · string

pipelines.currentRun.steps. transformationBlockId · integer

pipelines.currentRun.steps. builtinTransformationBlock · object

pipelines.currentRun.steps. category · enum<string>

Available options: training, testing, split

pipelines.currentRun.steps. outputDatasetName · string

pipelines.currentRun.steps. outputDatasetBucketId · integer

pipelines.currentRun.steps. outputDatasetBucketPath · string

pipelines.currentRun.steps. label · string

pipelines.currentRun.steps. extraCliArguments · string

pipelines.currentRun.steps. parameters · object

Show child attributes

pipelines.currentRun.steps.parameters. {key} · string

pipelines.currentRun. created · string<date-time> · required

pipelines.currentRun. finished · string<date-time>

pipelines.currentRun. itemCountBefore · object

Item count before the pipeline ran, only set when the pipeline has a dataset attached.

Show child attributes

pipelines.currentRun.itemCountBefore. itemCount · integer · required

pipelines.currentRun.itemCountBefore. itemCountChecklistOK · integer · required

pipelines.currentRun.itemCountBefore. itemCountChecklistFailed · integer · required

pipelines.currentRun. itemCountAfter · object

Item count after the pipeline ran, only set when the pipeline has a dataset attached.

Show child attributes

pipelines.currentRun.itemCountAfter. itemCount · integer · required

pipelines.currentRun.itemCountAfter. itemCountChecklistOK · integer · required

pipelines.currentRun.itemCountAfter. itemCountChecklistFailed · integer · required

pipelines.currentRun. itemCountImportIntoProjectFailed · integer

Number of data items that failed to import into a project (through the s3-to-project, portal-to-project or dataset-to-project) transform blocks

pipelines. lastRun · object

Show child attributes

pipelines.lastRun. id · integer · required

pipelines.lastRun. steps · object[] · required

Show child attributes

pipelines.lastRun.steps. name · string · required

pipelines.lastRun.steps. transformationJob · object

Show child attributes

pipelines.lastRun.steps.transformationJob. id · integer · required

pipelines.lastRun.steps.transformationJob. organizationId · integer · required

pipelines.lastRun.steps.transformationJob. name · string · required

pipelines.lastRun.steps.transformationJob. uploadType · enum<string> · required

Available options: dataset, project

pipelines.lastRun.steps.transformationJob. status · enum<string> · required

Available options: waiting, created, started, finished, failed

pipelines.lastRun.steps.transformationJob. transformJobStatus · enum<string> · required

Available options: waiting, created, started, finished, failed

pipelines.lastRun.steps.transformationJob. uploadJobStatus · enum<string> · required

Available options: waiting, created, started, finished, failed

pipelines.lastRun.steps.transformationJob. category · enum<string> · required

Available options: training, testing, split

pipelines.lastRun.steps.transformationJob. created · string<date-time> · required

pipelines.lastRun.steps.transformationJob. totalDownloadFileCount · integer · required

pipelines.lastRun.steps.transformationJob. totalDownloadFileSize · integer · required

pipelines.lastRun.steps.transformationJob. totalDownloadFileSizeString · string · required

pipelines.lastRun.steps.transformationJob. totalUploadFileCount · integer · required

pipelines.lastRun.steps.transformationJob. transformationParallel · integer · required

Number of transformation jobs that can be ran in parallel

pipelines.lastRun.steps.transformationJob. transformationSummary · object · required

Show child attributes

pipelines.lastRun.steps.transformationJob.transformationSummary. startedCount · integer · required

pipelines.lastRun.steps.transformationJob.transformationSummary. succeededCount · integer · required

pipelines.lastRun.steps.transformationJob.transformationSummary. finishedCount · integer · required

pipelines.lastRun.steps.transformationJob.transformationSummary. totalFileCount · integer · required

pipelines.lastRun.steps.transformationJob.transformationSummary. totalTimeSpentSeconds · integer · required

Total amount of compute used for this job (in seconds)

pipelines.lastRun.steps.transformationJob. inProgress · boolean · required

pipelines.lastRun.steps.transformationJob. operatesOn · enum<string> · required

Available options: file, directory, standalone

pipelines.lastRun.steps.transformationJob. totalTimeSpentSeconds · integer · required

Total amount of compute used for this job (in seconds)

pipelines.lastRun.steps.transformationJob. totalTimeSpentString · string · required

Total amount of compute used (friendly string)

pipelines.lastRun.steps.transformationJob. uploadJobId · integer

pipelines.lastRun.steps.transformationJob. uploadJobFilesUploaded · integer

pipelines.lastRun.steps.transformationJob. projectOwner · string

pipelines.lastRun.steps.transformationJob. projectId · integer

pipelines.lastRun.steps.transformationJob. projectName · string

pipelines.lastRun.steps.transformationJob. transformationBlockId · integer

pipelines.lastRun.steps.transformationJob. builtinTransformationBlock · object

pipelines.lastRun.steps.transformationJob. transformationBlockName · string

pipelines.lastRun.steps.transformationJob. outputDatasetName · string

pipelines.lastRun.steps.transformationJob. outputDatasetBucketId · integer

pipelines.lastRun.steps.transformationJob. outputDatasetBucketPath · string

pipelines.lastRun.steps.transformationJob. label · string

pipelines.lastRun.steps.transformationJob. filterQuery · string

pipelines.lastRun.steps.transformationJob. emailRecipientUids · integer[]

pipelines.lastRun.steps.transformationJob. pipelineId · integer

pipelines.lastRun.steps.transformationJob. pipelineName · string

pipelines.lastRun.steps.transformationJob. pipelineRunId · integer

pipelines.lastRun.steps.transformationJob. pipelineStep · integer

pipelines.lastRun.steps.transformationJob. createdByUser · object

Show child attributes

pipelines.lastRun.steps.transformationJob.createdByUser. id · integer · required

pipelines.lastRun.steps.transformationJob.createdByUser. name · string · required

pipelines.lastRun.steps.transformationJob.createdByUser. username · string · required

pipelines.lastRun.steps.transformationJob.createdByUser. photo · string

pipelines.lastRun.steps. filter · string

pipelines.lastRun.steps. uploadType · enum<string>

Available options: project, dataset

pipelines.lastRun.steps. projectId · integer

pipelines.lastRun.steps. newProjectName · string

pipelines.lastRun.steps. projectApiKey · string

pipelines.lastRun.steps. projectHmacKey · string

pipelines.lastRun.steps. transformationBlockId · integer

pipelines.lastRun.steps. builtinTransformationBlock · object

pipelines.lastRun.steps. category · enum<string>

Available options: training, testing, split

pipelines.lastRun.steps. outputDatasetName · string

pipelines.lastRun.steps. outputDatasetBucketId · integer

pipelines.lastRun.steps. outputDatasetBucketPath · string

pipelines.lastRun.steps. label · string

pipelines.lastRun.steps. extraCliArguments · string

pipelines.lastRun.steps. parameters · object

Show child attributes

pipelines.lastRun.steps.parameters. {key} · string

pipelines.lastRun. created · string<date-time> · required

pipelines.lastRun. finished · string<date-time>

pipelines.lastRun. itemCountBefore · object

Item count before the pipeline ran, only set when the pipeline has a dataset attached.

Show child attributes

pipelines.lastRun.itemCountBefore. itemCount · integer · required

pipelines.lastRun.itemCountBefore. itemCountChecklistOK · integer · required

pipelines.lastRun.itemCountBefore. itemCountChecklistFailed · integer · required

pipelines.lastRun. itemCountAfter · object

Item count after the pipeline ran, only set when the pipeline has a dataset attached.

Show child attributes

pipelines.lastRun.itemCountAfter. itemCount · integer · required

pipelines.lastRun.itemCountAfter. itemCountChecklistOK · integer · required

pipelines.lastRun.itemCountAfter. itemCountChecklistFailed · integer · required

pipelines.lastRun. itemCountImportIntoProjectFailed · integer

Number of data items that failed to import into a project (through the s3-to-project, portal-to-project or dataset-to-project) transform blocks

pipelines. feedingIntoDataset · object

Show child attributes

pipelines.feedingIntoDataset. dataset · string · required

pipelines.feedingIntoDataset. datasetLink · string · required

pipelines.feedingIntoDataset. itemCount · integer · required

pipelines.feedingIntoDataset. itemCountChecklistOK · integer · required

pipelines.feedingIntoDataset. itemCountChecklistError · integer · required

pipelines.feedingIntoDataset. datasetType · enum<string>

Available options: clinical, files

pipelines. feedingIntoProject · object

Show child attributes

pipelines.feedingIntoProject. id · integer · required

pipelines.feedingIntoProject. name · string · required

pipelines.feedingIntoProject. projectLink · string · required

pipelines.feedingIntoProject. itemCount · integer · required

pipelines. lastRunStartError · string

pipelines. notificationWebhook · string

error · string

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