Query Pipeline Run

api_key

string

required

This is the API key for your account. You can obtain this from the “Secrets” tab of your “Settings” page.

subproject_id

string

required

This is the id of the subproject the pipeline run resides in. You can obtain this from the URL of the subproject page.

pipeline_id

string

required

This is the id of the pipeline that is associated with this run. You can obtain this from the table on the first tab of the pipeline modal.

pipeline_version

string

required

This is the version of the pipeline associated with this run. This is the name of the version indicated in the verison dropdown. The default version is “Version 1”.

pipeline_run_name

string

required

This is the name of the pipeline run to be queried.

status

number

Indicates whether the call was successful. 200 if successful, 400 if not.

message

object

Message containing the queried pipeline run.

name

string

required

This is the name of the pipeline run

description

string

This is the description of the pipeline run

creator

string

The name of the user who created the pipeline run

created_time

string

The time the pipeline run was created (epoch)

updated_time

string

The time the pipeline run was last modified (epoch)

run_date

string

This is the date the pipeline run was run (MM/DD/YYYY)

run_date

string

This is the date the pipeline run was run (MM/DD/YYYY)

steps

[Steps]

An array of the different steps in this pipeline run.

name

string

The name of the step

name

string

The type of the step (Static or Dynamic)

description

string

The description of the step

instance

[Resource instance]

The resource instance associated with this step

name

string

The name of the resource instance.

description

string

The description of the resource instance

input_notes

string

Notes on the input datasets of the resource instance

output_notes

string

Notes on the output artifacts of the resource instance

deployment_notes

string

Notes on the deployments of the resource instance

origin_notes

string

Notes on the origins of the resource instance

input_datasets

[Input Dataset]

The input datasets of the resource instance

output_artifacts

[Output Artifact]

The output artifacts of the resource instance

content_notes

string

The content notes of the resource instance

deployments

[Deployment]

The deployments of the resource instance

origins

[Origin]

The origins of the resource instance

fields

[Field]

The fields of the resource instance

underlying_resource_id

string

The id of the resource associated with this resource instance

underlying_resource_version

string

The version of the resource associated with this resource instance

underlying_resource_description

string

The description of the resource associated with this resource instance

underlying_resource_content

[Content]

The content of the resource associated with this resource instance

underlying_resource_content_notes

string

The content notes of the resource associated with this resource instance

Getting Started

Organize your Team

Resources

Modules

Pipelines

Placeable Processes

Views

Artemis API

Legal/Privacy

Query Pipeline Run

Body

Response

Getting Started

Organize your Team

Resources

Modules

Pipelines

Placeable Processes

Views

Artemis API

Legal/Privacy

​Body

​Response

Body

Response