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

Body

success*boolean

Whether the operation succeeded

errorstring

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

pipeline*OrganizationPipeline (object)

id*integer

name*string

description*string

intervalStrstring

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

steps*array of OrganizationPipelineStep (object)

name*string

filterstring

pathFiltersarray of OrganizationCreateProjectPathFilter (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.

dataset*string

Dataset name of files to transform

filter*string

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)

uploadTypeenum

projectdataset

projectIdinteger

newProjectNamestring

projectApiKeystring

projectHmacKeystring

transformationBlockIdinteger

builtinTransformationBlockobject

categoryenum

trainingtestingsplit

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

outputPathInDatasetstring

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

outputDatasetPathRuleOrganizationCreateProjectOutputDatasetPathRule (enum)

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

no-subfolderssubfolder-per-itemuse-full-path

labelstring

transformationParallelinteger

extraCliArgumentsstring

parametersobject

Other propertiesstring

nextRunstring (date-time)

created*string (date-time)

currentRunOrganizationPipelineRun (object)

id*integer

steps*array of OrganizationPipelineRunStep (object)

name*string

transformationJobOrganizationCreateProject (object)

id*integer

organizationId*integer

name*string

uploadType*enum

datasetproject

status*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

transformJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

uploadJobIdinteger

uploadJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

uploadJobFilesUploadedinteger

projectOwnerstring

projectIdinteger

projectNamestring

transformationBlockIdinteger

builtinTransformationBlockobject

transformationBlockNamestring

category*enum

trainingtestingsplit

created*string (date-time)

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

totalDownloadFileCount*integer

totalDownloadFileSize*integer

totalDownloadFileSizeString*string

totalUploadFileCount*integer

transformationParallel*integer

Number of transformation jobs that can be ran in parallel

transformationSummary*object

startedCount*integer

succeededCount*integer

finishedCount*integer

totalFileCount*integer

totalTimeSpentSeconds*integer

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

inProgress*boolean

labelstring

filterQuerystring

emailRecipientUidsarray of integer

itemsinteger

pipelineIdinteger

pipelineNamestring

pipelineRunIdinteger

pipelineStepinteger

operatesOn*TransformationJobOperatesOnEnum (enum)

filedirectorystandalone

totalTimeSpentSeconds*integer

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

totalTimeSpentString*string

Total amount of compute used (friendly string)

createdByUserCreatedUpdatedByUser (object)

id*integer

name*string

username*string

photostring

filterstring

uploadTypeenum

projectdataset

projectIdinteger

newProjectNamestring

projectApiKeystring

projectHmacKeystring

transformationBlockIdinteger

builtinTransformationBlockobject

categoryenum

trainingtestingsplit

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

labelstring

extraCliArgumentsstring

parametersobject

Other propertiesstring

created*string (date-time)

finishedstring (date-time)

itemCountBeforeOrganizationPipelineItemCount (object)

itemCount*integer

itemCountChecklistOK*integer

itemCountChecklistFailed*integer

itemCountAfterOrganizationPipelineItemCount (object)

itemCount*integer

itemCountChecklistOK*integer

itemCountChecklistFailed*integer

itemCountImportIntoProjectFailedinteger

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

lastRunOrganizationPipelineRun (object)

id*integer

steps*array of OrganizationPipelineRunStep (object)

name*string

transformationJobOrganizationCreateProject (object)

id*integer

organizationId*integer

name*string

uploadType*enum

datasetproject

status*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

transformJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

uploadJobIdinteger

uploadJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

uploadJobFilesUploadedinteger

projectOwnerstring

projectIdinteger

projectNamestring

transformationBlockIdinteger

builtinTransformationBlockobject

transformationBlockNamestring

category*enum

trainingtestingsplit

created*string (date-time)

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

totalDownloadFileCount*integer

totalDownloadFileSize*integer

totalDownloadFileSizeString*string

totalUploadFileCount*integer

transformationParallel*integer

Number of transformation jobs that can be ran in parallel

transformationSummary*object

startedCount*integer

succeededCount*integer

finishedCount*integer

totalFileCount*integer

totalTimeSpentSeconds*integer

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

inProgress*boolean

labelstring

filterQuerystring

emailRecipientUidsarray of integer

itemsinteger

pipelineIdinteger

pipelineNamestring

pipelineRunIdinteger

pipelineStepinteger

operatesOn*TransformationJobOperatesOnEnum (enum)

filedirectorystandalone

totalTimeSpentSeconds*integer

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

totalTimeSpentString*string

Total amount of compute used (friendly string)

createdByUserCreatedUpdatedByUser (object)

id*integer

name*string

username*string

photostring

filterstring

uploadTypeenum

projectdataset

projectIdinteger

newProjectNamestring

projectApiKeystring

projectHmacKeystring

transformationBlockIdinteger

builtinTransformationBlockobject

categoryenum

trainingtestingsplit

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

labelstring

extraCliArgumentsstring

parametersobject

Other propertiesstring

created*string (date-time)

finishedstring (date-time)

itemCountBeforeOrganizationPipelineItemCount (object)

itemCount*integer

itemCountChecklistOK*integer

itemCountChecklistFailed*integer

itemCountAfterOrganizationPipelineItemCount (object)

itemCount*integer

itemCountChecklistOK*integer

itemCountChecklistFailed*integer

itemCountImportIntoProjectFailedinteger

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

feedingIntoDatasetobject

dataset*string

datasetLink*string

itemCount*integer

itemCountChecklistOK*integer

itemCountChecklistError*integer

datasetTypeOrganizationDatasetTypeEnum (enum)

clinicalfiles

feedingIntoProjectobject

id*integer

name*string

projectLink*string

itemCount*integer

emailRecipientUids*array of integer

itemsinteger

lastRunStartErrorstring

notificationWebhookstring

whenToEmail*enum

alwayson_new_datanever

Request

Response

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

Body

success*boolean

Whether the operation succeeded

errorstring

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

pipeline*OrganizationPipeline (object)

id*integer

name*string

description*string

intervalStrstring

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

steps*array of OrganizationPipelineStep (object)

name*string

filterstring

pathFiltersarray of OrganizationCreateProjectPathFilter (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.

dataset*string

Dataset name of files to transform

filter*string

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)

uploadTypeenum

projectdataset

projectIdinteger

newProjectNamestring

projectApiKeystring

projectHmacKeystring

transformationBlockIdinteger

builtinTransformationBlockobject

categoryenum

trainingtestingsplit

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

outputPathInDatasetstring

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

outputDatasetPathRuleOrganizationCreateProjectOutputDatasetPathRule (enum)

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

no-subfolderssubfolder-per-itemuse-full-path

labelstring

transformationParallelinteger

extraCliArgumentsstring

parametersobject

Other propertiesstring

nextRunstring (date-time)

created*string (date-time)

currentRunOrganizationPipelineRun (object)

id*integer

steps*array of OrganizationPipelineRunStep (object)

name*string

transformationJobOrganizationCreateProject (object)

id*integer

organizationId*integer

name*string

uploadType*enum

datasetproject

status*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

transformJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

uploadJobIdinteger

uploadJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

uploadJobFilesUploadedinteger

projectOwnerstring

projectIdinteger

projectNamestring

transformationBlockIdinteger

builtinTransformationBlockobject

transformationBlockNamestring

category*enum

trainingtestingsplit

created*string (date-time)

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

totalDownloadFileCount*integer

totalDownloadFileSize*integer

totalDownloadFileSizeString*string

totalUploadFileCount*integer

transformationParallel*integer

Number of transformation jobs that can be ran in parallel

transformationSummary*object

startedCount*integer

succeededCount*integer

finishedCount*integer

totalFileCount*integer

totalTimeSpentSeconds*integer

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

inProgress*boolean

labelstring

filterQuerystring

emailRecipientUidsarray of integer

itemsinteger

pipelineIdinteger

pipelineNamestring

pipelineRunIdinteger

pipelineStepinteger

operatesOn*TransformationJobOperatesOnEnum (enum)

filedirectorystandalone

totalTimeSpentSeconds*integer

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

totalTimeSpentString*string

Total amount of compute used (friendly string)

createdByUserCreatedUpdatedByUser (object)

id*integer

name*string

username*string

photostring

filterstring

uploadTypeenum

projectdataset

projectIdinteger

newProjectNamestring

projectApiKeystring

projectHmacKeystring

transformationBlockIdinteger

builtinTransformationBlockobject

categoryenum

trainingtestingsplit

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

labelstring

extraCliArgumentsstring

parametersobject

Other propertiesstring

created*string (date-time)

finishedstring (date-time)

itemCountBeforeOrganizationPipelineItemCount (object)

itemCount*integer

itemCountChecklistOK*integer

itemCountChecklistFailed*integer

itemCountAfterOrganizationPipelineItemCount (object)

itemCount*integer

itemCountChecklistOK*integer

itemCountChecklistFailed*integer

itemCountImportIntoProjectFailedinteger

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

lastRunOrganizationPipelineRun (object)

id*integer

steps*array of OrganizationPipelineRunStep (object)

name*string

transformationJobOrganizationCreateProject (object)

id*integer

organizationId*integer

name*string

uploadType*enum

datasetproject

status*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

transformJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

uploadJobIdinteger

uploadJobStatus*TransformationJobStatusEnum (enum)

waitingcreatedstartedfinishedfailed

uploadJobFilesUploadedinteger

projectOwnerstring

projectIdinteger

projectNamestring

transformationBlockIdinteger

builtinTransformationBlockobject

transformationBlockNamestring

category*enum

trainingtestingsplit

created*string (date-time)

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

totalDownloadFileCount*integer

totalDownloadFileSize*integer

totalDownloadFileSizeString*string

totalUploadFileCount*integer

transformationParallel*integer

Number of transformation jobs that can be ran in parallel

transformationSummary*object

startedCount*integer

succeededCount*integer

finishedCount*integer

totalFileCount*integer

totalTimeSpentSeconds*integer

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

inProgress*boolean

labelstring

filterQuerystring

emailRecipientUidsarray of integer

itemsinteger

pipelineIdinteger

pipelineNamestring

pipelineRunIdinteger

pipelineStepinteger

operatesOn*TransformationJobOperatesOnEnum (enum)

filedirectorystandalone

totalTimeSpentSeconds*integer

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

totalTimeSpentString*string

Total amount of compute used (friendly string)

createdByUserCreatedUpdatedByUser (object)

id*integer

name*string

username*string

photostring

filterstring

uploadTypeenum

projectdataset

projectIdinteger

newProjectNamestring

projectApiKeystring

projectHmacKeystring

transformationBlockIdinteger

builtinTransformationBlockobject

categoryenum

trainingtestingsplit

outputDatasetNamestring

outputDatasetBucketIdinteger

outputDatasetBucketPathstring

labelstring

extraCliArgumentsstring

parametersobject

Other propertiesstring

created*string (date-time)

finishedstring (date-time)

itemCountBeforeOrganizationPipelineItemCount (object)

itemCount*integer

itemCountChecklistOK*integer

itemCountChecklistFailed*integer

itemCountAfterOrganizationPipelineItemCount (object)

itemCount*integer

itemCountChecklistOK*integer

itemCountChecklistFailed*integer

itemCountImportIntoProjectFailedinteger

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

feedingIntoDatasetobject

dataset*string

datasetLink*string

itemCount*integer

itemCountChecklistOK*integer

itemCountChecklistError*integer

datasetTypeOrganizationDatasetTypeEnum (enum)

clinicalfiles

feedingIntoProjectobject

id*integer

name*string

projectLink*string

itemCount*integer

emailRecipientUids*array of integer

itemsinteger

lastRunStartErrorstring

notificationWebhookstring

whenToEmail*enum

alwayson_new_datanever

Request

Response

{
  "success": false,
  "error": "text",
  "pipeline": {
    "id": 0,
    "name": "text",
    "description": "text",
    "intervalStr": "text",
    "steps": [
      {
        "name": "text",
        "filter": "text",
        "pathFilters": [
          {
            "dataset": "text",
            "filter": "text"
          }
        ],
        "uploadType": "project",
        "projectId": 0,
        "newProjectName": "text",
        "projectApiKey": "text",
        "projectHmacKey": "text",
        "transformationBlockId": 0,
        "category": "training",
        "outputDatasetName": "text",
        "outputDatasetBucketId": 0,
        "outputDatasetBucketPath": "text",
        "outputPathInDataset": "text",
        "outputDatasetPathRule": "no-subfolders",
        "label": "text",
        "transformationParallel": 0,
        "extraCliArguments": "text"
      }
    ],
    "nextRun": "2024-12-21T16:33:49.756Z",
    "created": "2024-12-21T16:33:49.756Z",
    "currentRun": {
      "id": 0,
      "steps": [
        {
          "name": "text",
          "transformationJob": {
            "id": 0,
            "organizationId": 0,
            "name": "text",
            "uploadType": "dataset",
            "status": "waiting",
            "transformJobStatus": "waiting",
            "uploadJobId": 0,
            "uploadJobStatus": "waiting",
            "uploadJobFilesUploaded": 0,
            "projectOwner": "text",
            "projectId": 0,
            "projectName": "text",
            "transformationBlockId": 0,
            "transformationBlockName": "text",
            "category": "training",
            "created": "2024-12-21T16:33:49.756Z",
            "outputDatasetName": "text",
            "outputDatasetBucketId": 0,
            "outputDatasetBucketPath": "text",
            "totalDownloadFileCount": 0,
            "totalDownloadFileSize": 0,
            "totalDownloadFileSizeString": "text",
            "totalUploadFileCount": 0,
            "transformationParallel": 0,
            "transformationSummary": {
              "startedCount": 0,
              "succeededCount": 0,
              "finishedCount": 0,
              "totalFileCount": 0,
              "totalTimeSpentSeconds": 0
            },
            "inProgress": false,
            "label": "text",
            "filterQuery": "text",
            "emailRecipientUids": [
              0
            ],
            "pipelineId": 0,
            "pipelineName": "text",
            "pipelineRunId": 0,
            "pipelineStep": 0,
            "operatesOn": "file",
            "totalTimeSpentSeconds": 0,
            "totalTimeSpentString": "text",
            "createdByUser": {
              "id": 0,
              "name": "text",
              "username": "text",
              "photo": "text"
            }
          },
          "filter": "text",
          "uploadType": "project",
          "projectId": 0,
          "newProjectName": "text",
          "projectApiKey": "text",
          "projectHmacKey": "text",
          "transformationBlockId": 0,
          "category": "training",
          "outputDatasetName": "text",
          "outputDatasetBucketId": 0,
          "outputDatasetBucketPath": "text",
          "label": "text",
          "extraCliArguments": "text"
        }
      ],
      "created": "2024-12-21T16:33:49.756Z",
      "finished": "2024-12-21T16:33:49.756Z",
      "itemCountBefore": {
        "itemCount": 0,
        "itemCountChecklistOK": 0,
        "itemCountChecklistFailed": 0
      },
      "itemCountAfter": {
        "itemCount": 0,
        "itemCountChecklistOK": 0,
        "itemCountChecklistFailed": 0
      },
      "itemCountImportIntoProjectFailed": 0
    },
    "lastRun": {
      "id": 0,
      "steps": [
        {
          "name": "text",
          "transformationJob": {
            "id": 0,
            "organizationId": 0,
            "name": "text",
            "uploadType": "dataset",
            "status": "waiting",
            "transformJobStatus": "waiting",
            "uploadJobId": 0,
            "uploadJobStatus": "waiting",
            "uploadJobFilesUploaded": 0,
            "projectOwner": "text",
            "projectId": 0,
            "projectName": "text",
            "transformationBlockId": 0,
            "transformationBlockName": "text",
            "category": "training",
            "created": "2024-12-21T16:33:49.756Z",
            "outputDatasetName": "text",
            "outputDatasetBucketId": 0,
            "outputDatasetBucketPath": "text",
            "totalDownloadFileCount": 0,
            "totalDownloadFileSize": 0,
            "totalDownloadFileSizeString": "text",
            "totalUploadFileCount": 0,
            "transformationParallel": 0,
            "transformationSummary": {
              "startedCount": 0,
              "succeededCount": 0,
              "finishedCount": 0,
              "totalFileCount": 0,
              "totalTimeSpentSeconds": 0
            },
            "inProgress": false,
            "label": "text",
            "filterQuery": "text",
            "emailRecipientUids": [
              0
            ],
            "pipelineId": 0,
            "pipelineName": "text",
            "pipelineRunId": 0,
            "pipelineStep": 0,
            "operatesOn": "file",
            "totalTimeSpentSeconds": 0,
            "totalTimeSpentString": "text",
            "createdByUser": {
              "id": 0,
              "name": "text",
              "username": "text",
              "photo": "text"
            }
          },
          "filter": "text",
          "uploadType": "project",
          "projectId": 0,
          "newProjectName": "text",
          "projectApiKey": "text",
          "projectHmacKey": "text",
          "transformationBlockId": 0,
          "category": "training",
          "outputDatasetName": "text",
          "outputDatasetBucketId": 0,
          "outputDatasetBucketPath": "text",
          "label": "text",
          "extraCliArguments": "text"
        }
      ],
      "created": "2024-12-21T16:33:49.756Z",
      "finished": "2024-12-21T16:33:49.756Z",
      "itemCountBefore": {
        "itemCount": 0,
        "itemCountChecklistOK": 0,
        "itemCountChecklistFailed": 0
      },
      "itemCountAfter": {
        "itemCount": 0,
        "itemCountChecklistOK": 0,
        "itemCountChecklistFailed": 0
      },
      "itemCountImportIntoProjectFailed": 0
    },
    "feedingIntoDataset": {
      "dataset": "text",
      "datasetLink": "text",
      "itemCount": 0,
      "itemCountChecklistOK": 0,
      "itemCountChecklistError": 0,
      "datasetType": "clinical"
    },
    "feedingIntoProject": {
      "id": 0,
      "name": "text",
      "projectLink": "text",
      "itemCount": 0
    },
    "emailRecipientUids": [
      0
    ],
    "lastRunStartError": "text",
    "notificationWebhook": "text",
    "whenToEmail": "always"
  }
}