Search all the final workflow graphs.

Prev Next
Get
/v1/workflows/final/graphs
Security
API Key: bearerToken
Header parameter nameAuthentication

A JWT bearer token to be passed once authenticated.

Query parameters
name
string

Final workflow name

description
string

Final workflow description.

project
string

The workflow project.

filter
string

Filter to use for contained workflow versions, currently supports labels, syntax: {"labels":{"key1":"value1","key2":"value2"}}

all_search
string

Search on name or description.

sort_by
string

Sort fields. In the format of key1:ASC,key2:DESC,key3:DESC

limit
integer

Maximum numbers of workflows to return.

offset
integer

Number of workflows to skip from start.

Responses
200
Expand All
object
metadata
object (SearchMetadata)
page
integer

Current page number

pages
integer

Total pages as per the item counts and page limit.

limit
integer

Number of items to limit in a page.

total_count
integer

Total number of unfiltered items.

filtered_count
integer

Total number of items as per the current filter.

items
Array of object (FinalWorkflow)
object
graph_id
string (uuid)
name
string
group_id
string (uuid)
acct_id
string (uuid)
created_at
integer (int64)

Dataset creation time (seconds since epoch).

updated_at
integer (int64)

Last update UNIX timestamp (seconds since epoch).

description
string
versions
object
property*
object (FinalWorkflowGraph) additionalProperties
created_at
integer (int64)

Dataset creation time.

objects
object
property*
object (WorkflowObject) additionalProperties
name
string
user_id
string (uuid)
description
string
ref
object (WorkflowObjectRef)
placeholder
object (WorkflowObjectRefPlaceholder)
kind
string
Valid values[ "dataset", "app", "script" ]
acct_id
string (uuid)
group_id
string (uuid)
dataset
object (WorkflowObjectRefDataset)
dataset_id
string (uuid)
acct_id
string (uuid)
group_id
string (uuid)
app
object (WorkflowObjectRefApp)
image_id
string (uuid)
config_id
string
acct_id
string (uuid)
group_id
string (uuid)
edges
object
property*
object (WorkflowEdge) additionalProperties
source
object (WorkflowEdgeLink)
id
string
port
string
target
object (WorkflowEdgeLink)
id
string
port
string
metadata
object (WorkflowMetadata)
nodes
object
property*
object additionalProperties
parent
object (WorkflowLinkMetadata)

The final workflow from which this draft was derived. This field may point to a deleted final workflow in which you should treat it as if it's not present.

graph_id
string (uuid)
source_version
integer
project
string
runtime_configs
object
property*
object (WorkflowObjectFinalApp) additionalProperties
image_id
string (uuid)
config_id
string
deployment
object (WorkflowAppDeployment)

Deployment info for an app. Exactly one of kubernetes or aci field must be set.

kubernetes
object (WorkflowAppKubernetes)
job_spec
object
aci
object (WorkflowAppAci)
exposed_ports
Array of object (DockerNetworkPort)

List of ports exposed for the azure container instance.

object

A port exposed by a docker container.

port
integer

A valid, specific port number from 1..65535 (inclusive).

protocol
string

Protocol Associated with a Port exposed by a docker container.

Valid values[ "Tcp", "Udp" ]
env_vars
object
property*
string additionalProperties
child_nodes
Array of string
string
deployment
object (WorkflowDeployment)

Deployment info for a workflow. Exactly one of kubernetes_single_job or aci_single_job field must be set.

kubernetes_single_job
object (KubernetesSingleJob)
namespace
string
cluster_id
string (uuid)
aci_single_job
object (AciSingleJob)
cluster_id
string (uuid)
deployment_location
string
labels
object
property*
string additionalProperties
type
string

Workflow is owned or Shared

Valid values[ "OWNED", "SHARED" ]