1. Workflow API

1.1. Python

The Python API is the most powerful way of creating Pegasus workflows.

1.1.1. Pegasus.api package

Example workflow generator using the Python API:

import logging

from pathlib import Path

from Pegasus.api import *

logging.basicConfig(level=logging.DEBUG)

# --- Replicas -----------------------------------------------------------------
with open("f.a", "w") as f:
   f.write("This is sample input to KEG")

fa = File("f.a").add_metadata(creator="ryan")
rc = ReplicaCatalog().add_replica("local", fa, Path(".").resolve() / "f.a")

# --- Transformations ----------------------------------------------------------
preprocess = Transformation(
               "preprocess",
               site="condorpool",
               pfn="/usr/bin/pegasus-keg",
               is_stageable=False,
               arch=Arch.X86_64,
               os_type=OS.LINUX
            )

findrange = Transformation(
               "findrange",
               site="condorpool",
               pfn="/usr/bin/pegasus-keg",
               is_stageable=False,
               arch=Arch.X86_64,
               os_type=OS.LINUX
            )

analyze = Transformation(
               "analyze",
               site="condorpool",
               pfn="/usr/bin/pegasus-keg",
               is_stageable=False,
               arch=Arch.X86_64,
               os_type=OS.LINUX
            )

tc = TransformationCatalog().add_transformations(preprocess, findrange, analyze)

# --- Workflow -----------------------------------------------------------------
'''
                     [f.b1] - (findrange) - [f.c1]
                     /                             \
[f.a] - (preprocess)                               (analyze) - [f.d]
                     \                             /
                     [f.b2] - (findrange) - [f.c2]

'''
wf = Workflow("blackdiamond")

fb1 = File("f.b1")
fb2 = File("f.b2")
job_preprocess = Job(preprocess)\
                     .add_args("-a", "preprocess", "-T", "3", "-i", fa, "-o", fb1, fb2)\
                     .add_inputs(fa)\
                     .add_outputs(fb1, fb2)

fc1 = File("f.c1")
job_findrange_1 = Job(findrange)\
                     .add_args("-a", "findrange", "-T", "3", "-i", fb1, "-o", fc1)\
                     .add_inputs(fb1)\
                     .add_outputs(fc1)

fc2 = File("f.c2")
job_findrange_2 = Job(findrange)\
                     .add_args("-a", "findrange", "-T", "3", "-i", fb2, "-o", fc2)\
                     .add_inputs(fb2)\
                     .add_outputs(fc2)

fd = File("f.d")
job_analyze = Job(analyze)\
               .add_args("-a", "analyze", "-T", "3", "-i", fc1, fc2, "-o", fd)\
               .add_inputs(fc1, fc2)\
               .add_outputs(fd)

wf.add_jobs(job_preprocess, job_findrange_1, job_findrange_2, job_analyze)
wf.add_replica_catalog(rc)
wf.add_transformation_catalog(tc)

try:
   wf.plan(submit=True)\
         .wait()\
         .analyze()\
         .statistics()
except PegasusClientError as e:
   print(e)

1.2. Java

The Java DAX API provided with the Pegasus distribution allows easy creation of complex and huge workflows. The Java API is documented using Javadoc for ADAGs .

The steps involved in creating a DAX using the API are

Create a new ADAG object
Add any metadata attributes associated with the whole workflow.
Add any Workflow notification elements
Create File objects as necessary. You can augment the files with physical information, if you want to include them into your DAX. Otherwise, the physical information is determined from the replica catalog.
(Optional) Create Executable objects, if you want to include your transformation catalog into your DAX. Otherwise, the translation of a job/task into executable location happens with the transformation catalog.
Create a new Job object.
Add arguments, files, profiles, notifications and other information to the Job object
Add the job object to the ADAG object
Repeat step 4-6 as necessary.
Add all dependencies to the ADAG object.
Call the writeToFile() method on the ADAG object to render the XML DAX file.

An example Java code that generates the diamond dax show above is listed below. This same code can be found in the Pegasus distribution in the examples/grid-blackdiamond-java directory as BlackDiamonDAX.java:

/**
 *  Copyright 2007-2008 University Of Southern California
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

import edu.isi.pegasus.planner.dax.*;


/**
 * An example class to highlight how to use the JAVA DAX API to generate a diamond
 * DAX.
 *
 */
public class Diamond {



    public class Diamond {



    public ADAG generate(String site_handle, String pegasus_location) throws Exception {

        java.io.File cwdFile = new java.io.File (".");
        String cwd = cwdFile.getCanonicalPath();

        ADAG dax = new ADAG("diamond");
        dax.addNotification(Invoke.WHEN.start,"/pegasus/libexec/notification/email -t notify@example.com");
        dax.addNotification(Invoke.WHEN.at_end,"/pegasus/libexec/notification/email -t notify@example.com");
        dax.addMetadata( "name", "diamond");
        dax.addMetadata( "createdBy", "Karan Vahi");

        File fa = new File("f.a");
        fa.addPhysicalFile("file://" + cwd + "/f.a", "local");
        fa.addMetaData( "size", "1024" );
        dax.addFile(fa);

        File fb1 = new File("f.b1");
        File fb2 = new File("f.b2");
        File fc1 = new File("f.c1");
        File fc2 = new File("f.c2");
        File fd = new File("f.d");
        fd.setRegister(true);

        Executable preprocess = new Executable("pegasus", "preprocess", "4.0");
        preprocess.setArchitecture(Executable.ARCH.X86).setOS(Executable.OS.LINUX);
        preprocess.setInstalled(true);
        preprocess.addPhysicalFile("file://" + pegasus_location + "/bin/keg", site_handle);
        preprocess.addMetaData( "size", "2048" );

        Executable findrange = new Executable("pegasus", "findrange", "4.0");
        findrange.setArchitecture(Executable.ARCH.X86).setOS(Executable.OS.LINUX);
        findrange.setInstalled(true);
        findrange.addPhysicalFile("file://" + pegasus_location + "/bin/keg", site_handle);

        Executable analyze = new Executable("pegasus", "analyze", "4.0");
        analyze.setArchitecture(Executable.ARCH.X86).setOS(Executable.OS.LINUX);
        analyze.setInstalled(true);
        analyze.addPhysicalFile("file://" + pegasus_location + "/bin/keg", site_handle);

        dax.addExecutable(preprocess).addExecutable(findrange).addExecutable(analyze);

        // Add a preprocess job
        Job j1 = new Job("j1", "pegasus", "preprocess", "4.0");
        j1.addArgument("-a preprocess -T 60 -i ").addArgument(fa);
        j1.addArgument("-o ").addArgument(fb1);
        j1.addArgument(" ").addArgument(fb2);
        j1.addMetadata( "time", "60" );
        j1.uses(fa, File.LINK.INPUT);
        j1.uses(fb1, File.LINK.OUTPUT);
        j1.uses(fb2, File.LINK.OUTPUT);
        j1.addNotification(Invoke.WHEN.start,"/pegasus/libexec/notification/email -t notify@example.com");
        j1.addNotification(Invoke.WHEN.at_end,"/pegasus/libexec/notification/email -t notify@example.com");
        dax.addJob(j1);

        // Add left Findrange job
        Job j2 = new Job("j2", "pegasus", "findrange", "4.0");
        j2.addArgument("-a findrange -T 60 -i ").addArgument(fb1);
        j2.addArgument("-o ").addArgument(fc1);
        j2.addMetadata( "time", "60" );
        j2.uses(fb1, File.LINK.INPUT);
        j2.uses(fc1, File.LINK.OUTPUT);
        j2.addNotification(Invoke.WHEN.start,"/pegasus/libexec/notification/email -t notify@example.com");
        j2.addNotification(Invoke.WHEN.at_end,"/pegasus/libexec/notification/email -t notify@example.com");
        dax.addJob(j2);

        // Add right Findrange job
        Job j3 = new Job("j3", "pegasus", "findrange", "4.0");
        j3.addArgument("-a findrange -T 60 -i ").addArgument(fb2);
        j3.addArgument("-o ").addArgument(fc2);
        j3.addMetadata( "time", "60" );
        j3.uses(fb2, File.LINK.INPUT);
        j3.uses(fc2, File.LINK.OUTPUT);
        j3.addNotification(Invoke.WHEN.start,"/pegasus/libexec/notification/email -t notify@example.com");
        j3.addNotification(Invoke.WHEN.at_end,"/pegasus/libexec/notification/email -t notify@example.com");
        dax.addJob(j3);

        // Add analyze job
        Job j4 = new Job("j4", "pegasus", "analyze", "4.0");
        j4.addArgument("-a analyze -T 60 -i ").addArgument(fc1);
        j4.addArgument(" ").addArgument(fc2);
        j4.addArgument("-o ").addArgument(fd);
        j4.addMetadata( "time", "60" );
        j4.uses(fc1, File.LINK.INPUT);
        j4.uses(fc2, File.LINK.INPUT);
        j4.uses(fd, File.LINK.OUTPUT);
        j4.addNotification(Invoke.WHEN.start,"/pegasus/libexec/notification/email -t notify@example.com");
        j4.addNotification(Invoke.WHEN.at_end,"/pegasus/libexec/notification/email -t notify@example.com");
        dax.addJob(j4);

        dax.addDependency("j1", "j2");
        dax.addDependency("j1", "j3");
        dax.addDependency("j2", "j4");
        dax.addDependency("j3", "j4");
        return dax;
    }

    /**
     * Create an example DIAMOND DAX
     * @param args
     */
    public static void main(String[] args) {
        if (args.length != 1) {
            System.out.println("Usage: java GenerateDiamondDAX  <pegasus_location> ");
            System.exit(1);
        }

        try {
            Diamond diamond = new Diamond();
            String pegasusHome = args[0];
            String site = "TestCluster";
            ADAG dag = diamond.generate( site, pegasusHome );
            dag.writeToSTDOUT();
            //generate(args[0], args[1]).writeToFile(args[2]);
        }
        catch (Exception e) {
            e.printStackTrace();
        }

    }
}

Of course, you will have to set up some catalogs and properties to run this example.

1.3. R

The R Pegasus API provided with the Pegasus distribution allows easy creation of complex and large scale workflows in R environments. The API follows the Google’ R style guide, and all objects and methods are defined using the S3 OOP system.

The API can be installed as follows:

Installing from source package (.tar.gz) in an R environment:
```
install.packages("/path/to/source/package.tar.gz", repo=NULL)
```
The source package can be obtained using pegasus-config --r or from the Pegasus’ downloads page.

The R API is well documented using Roxygen2. In an R environment, it can be accessed using help(package=pegasus). A PDF manual is also available.

The steps involved in creating an abstrace workflow using the API include:

Create a new Workflow object
Add any metadata attributes associated with the whole workflow.
Add any workflow notification elements.
Create File objects as necessary. You can augment the files with physical information, if you want to include them into your workflow. Otherwise, the physical information is determined from the replica catalog.
(Optional) Create Executable objects, if you want to include your transformation catalog into your workflow. Otherwise, the translation of a job/task into executable location happens with the transformation catalog.
Create a new Job object.
Add arguments, files, profiles, notifications, and other information to the Job object.
Add the job object to the Workflow object.
Repeat steps 4-6 as necessary.
Add all dependencies to the Workflow object.
Call the WriteYAML() method on the Workflow object to render the YAML workflow file.

Example R code that generates a workflow is shown below:

#!/usr/bin/Rscript

library(pegasus)

# Create an abstract workflow
diamond <- Workflow("diamond")

# Add some metadata
diamond <- Metadata(diamond, "name", "diamond")
diamond <- Metadata(diamond, "createdby", "Rafael Ferreira da Silva")

# Add input file to the DAX-level replica catalog
a <- File("f.a")
a <- AddPFN(a, PFN("gsiftp://site.com/inputs/f.a","site"))
a <- Metadata(a, "size", "1024")
diamond <- AddFile(diamond, a)

# Add executables to the DAX-level replica catalog
e_preprocess <- Executable(namespace="diamond", name="preprocess", version="4.0", os="linux", arch="x86_64")
e_preprocess <- Metadata(e_preprocess, "size", "2048")
e_preprocess <- AddPFN(e_preprocess, PFN("gsiftp://site.com/bin/preprocess","site"))
diamond <- AddExecutable(diamond, e_preprocess)

e_findrange <- Executable(namespace="diamond", name="findrange", version="4.0", os="linux", arch="x86_64")
e_findrange <- AddPFN(e_findrange, PFN("gsiftp://site.com/bin/findrange","site"))
diamond <- AddExecutable(diamond, e_findrange)

e_analyze <- Executable(namespace="diamond", name="analyze", version="4.0", os="linux", arch="x86_64")
e_analyze <- AddPFN(e_analyze, PFN("gsiftp://site.com/bin/analyze","site"))
diamond <- AddExecutable(diamond, e_analyze)

# Add a preprocess job
preprocess <- Job(e.preprocess)
preprocess <- Metadata(preprocess, "time", "60")
b1 <- File("f.b1")
b2 <- File("f.b2")
preprocess <- AddArguments(preprocess, list("-a","preprocess","-T","3","-i",a,"-o",b1,b2))
preprocess <- Uses(preprocess, a, link=Pegasus.Link$INPUT)
preprocess <- Uses(preprocess, b1, link=Pegasus.Link$OUTPUT, transfer=TRUE)
preprocess <- Uses(preprocess, b2, link=Pegasus.Link$OUTPUT, transfer=TRUE)
diamond <- AddJob(diamond, preprocess)

# Add left Findrange job
frl <- Job(e.findrange)
frl <- Metadata(frl, "time", "60")
c1 <- File("f.c1")
frl <- AddArguments(frl, list("-a","findrange","-T","3","-i",b1,"-o",c1))
frl <- Uses(frl, b1, link=Pegasus.Link$INPUT)
frl <- Uses(frl, c1, link=Pegasus.Link$OUTPUT, transfer=TRUE)
diamond <- AddJob(diamond, frl)

# Add right Findrange job
frr <- Job(e.findrange)
frr <- Metadata(frr, "time", "60")
c2 <- File("f.c2")
frr <- AddArguments(frr, list("-a","findrange","-T","3","-i",b2,"-o",c2))
frr <- Uses(frr, b2, link=Pegasus.Link$INPUT)
frr <- Uses(frr, c2, link=Pegasus.Link$OUTPUT, transfer=TRUE)
diamond <- AddJob(diamond, frr)

# Add Analyze job
analyze <- Job(e.analyze)
analyze <- Metadata(analyze, "time", "60")
d <- File("f.d")
analyze <- AddArguments(analyze, list("-a","analyze","-T","3","-i",c1,c2,"-o",d))
analyze <- Uses(analyze, c1, link=Pegasus.Link$INPUT)
analyze <- Uses(analyze, c2, link=Pegasus.Link$INPUT)
analyze <- Uses(analyze, d, link=Pegasus.Link$OUTPUT, transfer=TRUE)
diamond <- AddJob(diamond, analyze)

# Add dependencies
diamond <- Depends(diamond, parent=preprocess, child=frl)
diamond <- Depends(diamond, parent=preprocess, child=frr)
diamond <- Depends(diamond, parent=frl, child=analyze)
diamond <- Depends(diamond, parent=frr, child=analyze)

# Get generated diamond dax
WriteYAML(diamond, stdout())

1.4. Monitoring REST API

Monitoring REST API allows developers to query a Pegasus workflow’s STAMPEDE database.

1.4.1. Resource Definition

1.4.1.1. Root Workflow

{
    "wf_id"             : <int:wf_id>,
    "wf_uuid"           : <string:wf_uuid>,
    "submit_hostname"   : <string:submit_hostname>,
    "submit_dir"        : <string:submit_dir>,
    "planner_arguments" : <string:planner_arguments>,
    "planner_version"   : <string:planner_version>,
    "user"              : <string:user>,
    "grid_dn"           : <string:grid_dn>,
    "dax_label"         : <string:dax_label>,
    "dax_version"       : <string:dax_version>,
    "dax_file"          : <string:dax_file>,
    "dag_file_name"     : <string:dag_file_name>,
    "timestamp"         : <int:timestamp>,
    "workflow_state"    : <object:workflow_state>,
}

1.4.1.2. Workflow

{
    "wf_id"             : <int:wf_id>,
    "root_wf_id"        : <int:root_wf_id>,
    "parent_wf_id"      : <int:parent_wf_id>,
    "wf_uuid"           : <string:wf_uuid>,
    "submit_hostname"   : <string:submit_hostname>,
    "submit_dir"        : <string:submit_dir>,
    "planner_arguments" : <string:planner_arguments>,
    "planner_version"   : <string:planner_version>,
    "user"              : <string:user>,
    "grid_dn"           : <string:grid_dn>,
    "dax_label"         : <string:dax_label>,
    "dax_version"       : <string:dax_version>,
    "dax_file"          : <string:dax_file>,
    "dag_file_name"     : <string:dag_file_name>,
    "timestamp"         : <int:timestamp>,
}

1.4.1.3. Workflow Metadata

{
    "key"    : <string:key>,
    "value"  : <string:value>,
}

1.4.1.4. Workflow Files

{
    "wf_id"  : <int:wf_id>,
    "lfn_id" : <string:lfn_id>,
    "lfn"    : <string:lfn>,
    "pfns"   : [
         {
            "pfn_id" : <int:pfn_id>,
            "pfn"    : <string:pfn>,
            "site"   : <string:site>
         }
    ],
    "meta" : [
         {
            "meta_id" : <int:meta_id>,
            "key"     : <string:key>,
            "value"   : <string:value>
         }
    ],
}

1.4.1.5. Workflow State

{
    "wf_id"         : int:wf_id,
    "state"         : <string:state>,
    "status"        : <int:status>,
    "restart_count" : <int:restart_count>,
    "timestamp"     : <datetime:timestamp>,
}

1.4.1.6. Job

{
    "job_id"      : <int: job_id>,
    "exec_job_id" : <string: exec_job_id>,
    "submit_file" : <string: submit_file>,
    "type_desc"   : <string: type_desc>,
    "max_retries" : <int: max_retries>,
    "clustered"   : <bool: clustered>,
    "task_count"  : <int: task_count>,
    "executable"  : <string: executable>,
    "argv"        : <string: argv>,
    "task_count"  : <int:task_count>,
}

1.4.1.7. Host

{
    "host_id"      : <int:host_id>,
    "site_name"    : <string:site_name>,
    "hostname"     : <string:hostname>,
    "ip"           : <string:ip>,
    "uname"        : <string:uname>,
    "total_memory" : <string:total_memory>,
}

1.4.1.8. Job State

{
    "job_instance_id"     : <int:job_instance_id>,
    "state"               : <string:state>,
    "jobstate_submit_seq" : <int:jobstate_submit_seq>,
    "timestamp"           : <int:timestamp>,
}

1.4.1.9. Task

{
    "task_id"        : <int:task_id>,
    "abs_task_id"    : <string:abs_task_id>,
    "type_desc"      : <string: type_desc>,
    "transformation" : <string:transformation>,
    "argv"           : <string:argv>,
}

1.4.1.10. Task Metadata

{
    "key"    : <string:key>,
    "value"  : <string:value>,
}

1.4.1.11. Job Instance

{
    "job_instance_id"   : <int:job_instance_id>,
    "host_id"           : <int:host_id>,
    "job_submit_seq"    : <int:job_submit_seq>,
    "sched_id"          : <string:sched_id>,
    "site_name"         : <string:site_name>,
    "user"              : <string:user>,
    "work_dir"          : <string:work_dir>,
    "cluster_start"     : <int:cluster_start>,
    "cluster_duration"  : <int:cluster_duration>,
    "local_duration"    : <int:local_duration>,
    "subwf_id"          : <int:subwf_id>,
    "stdout_text"       : <string:stdout_text>,
    "stderr_text"       : <string:stderr_text>,
    "stdin_file"        : <string:stdin_file>,
    "stdout_file"       : <string:stdout_file>,
    "stderr_file"       : <string:stderr_file>,
    "multiplier_factor" : <int:multiplier_factor>,
    "exitcode"          : <int:exitcode>,
}

1.4.1.12. Invocation

{
    "invocation_id"   : <int:invocation_id>,
    "job_instance_id" : <int:job_instance_id>,
    "abs_task_id"     : <string:abs_task_id>,
    "task_submit_seq" : <int:task_submit_seq>,
    "start_time"      : <int:start_time>,
    "remote_duration" : <int:remote_duration>,
    "remote_cpu_time" : <int:remote_cpu_time>,
    "exitcode"        : <int:exitcode>,
    "transformation"  : <string:transformation>,
    "executable"      : <string:executable>,
    "argv"            : <string:argv>,
}

1.4.1.13. RC LFN

{
    "lfn_id" : <int:pfn_id>,
    "lfn"    : <string:pfn>
}

1.4.1.14. RC PFN

{
    "pfn_id" : <int:pfn_id>,
    "pfn"    : <string:pfn>,
    "site"   : <string:site>
}

1.4.1.14.1. RC Metadata

{
    "meta_id" : <int:meta_id>,
    "key"     : <string:key>,
    "value"   : <string:value>
}

1.4.2. Endpoints

All URIs are prefixed by/api/v1/user/<string:user>.

All endpoints return response with content-type as application/json.

All endpoints support pretty-print query argument, to return a formatted JSON response.

All endpoints return status code 401 forAuthentication failure.

All endpoints return status code 403 forAuthorization failure.

GET /root

Retrieve all root workflows

Returns a collection of the Root Workflow resource

Query Parameters:

query (string) – A query to filter out records. See: Querying
order (string) – Result sorting criteria. See: Ordering
start-index (integer) – Return results starting from record <start-index> (0 indexed)
max-results (integer) – Max no. of records to return
pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
204 No Content – No content
400 Bad Request – Bad request
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
default – Internal server error

Response JSON Object:

[].archived (boolean)
[].dag_file_name (string)
[].dax_file (string)
[].dax_label (string)
[].dax_version (string)
[].grid_dn (string)
[].planner_arguments (string)
[].planner_version (string)
[].submit_dir (string)
[].submit_hostname (string)
[].timestamp (number)
[].user (string)
[].wf_id (integer)
[].wf_uuid (string)
[].workflow_state.restart_count (integer)
[].workflow_state.state (string)
[].workflow_state.status (integer)
[].workflow_state.timestamp (number)
[].workflow_state.wf_id (integer)

GET /root/{m-wf-id}

Retrieve a root workflow

Returns a Root Workflow resource identified by m_wf_id

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID

Query Parameters:

pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
404 Not Found – Not found
default – Internal server error

Response JSON Object:

[].archived (boolean)
[].dag_file_name (string)
[].dax_file (string)
[].dax_label (string)
[].dax_version (string)
[].grid_dn (string)
[].planner_arguments (string)
[].planner_version (string)
[].submit_dir (string)
[].submit_hostname (string)
[].timestamp (number)
[].user (string)
[].wf_id (integer)
[].wf_uuid (string)
[].workflow_state.restart_count (integer)
[].workflow_state.state (string)
[].workflow_state.status (integer)
[].workflow_state.timestamp (number)
[].workflow_state.wf_id (integer)

GET /root/{m-wf-id}/workflow

Retrieve all workflows

Returns a collection of the Workflow resource

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID

Query Parameters:

query (string) – A query to filter out records. See: Querying
order (string) – Result sorting criteria. See: Ordering
start-index (integer) – Return results starting from record <start-index> (0 indexed)
max-results (integer) – Max no. of records to return
pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
204 No Content – No content
400 Bad Request – Bad request
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
default – Internal server error

Response JSON Object:

[].dag_file_name (string)
[].dax_file (string)
[].dax_label (string)
[].dax_version (string)
[].grid_dn (string)
[].planner_arguments (string)
[].planner_version (string)
[].submit_dir (string)
[].submit_hostname (string)
[].timestamp (number)
[].user (string)
[].wf_id (integer)
[].wf_uuid (string)
[].workflow_state.restart_count (integer)
[].workflow_state.state (string)
[].workflow_state.status (integer)
[].workflow_state.timestamp (number)
[].workflow_state.wf_id (integer)

GET /root/{m-wf-id}/workflow/{wf-id}

Retrieve a workflow

Returns a Workflow resource identified by m_wf_id, wf_id

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID

Query Parameters:

pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
404 Not Found – Not found
default – Internal server error

Response JSON Object:

[].dag_file_name (string)
[].dax_file (string)
[].dax_label (string)
[].dax_version (string)
[].grid_dn (string)
[].planner_arguments (string)
[].planner_version (string)
[].submit_dir (string)
[].submit_hostname (string)
[].timestamp (number)
[].user (string)
[].wf_id (integer)
[].wf_uuid (string)
[].workflow_state.restart_count (integer)
[].workflow_state.state (string)
[].workflow_state.status (integer)
[].workflow_state.timestamp (number)
[].workflow_state.wf_id (integer)

GET /root/{m-wf-id}/workflow/{wf-id}/meta

Retrieve workflow metadata

Returns a collection of the WorkflowMetadata resource

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID

Query Parameters:

query (string) – A query to filter out records. See: Querying
order (string) – Result sorting criteria. See: Ordering
start-index (integer) – Return results starting from record <start-index> (0 indexed)
max-results (integer) – Max no. of records to return
pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
204 No Content – No content
400 Bad Request – Bad request
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
default – Internal server error

Response JSON Object:

[].key (string)
[].value (string)
[].wf_id (integer)

GET /root/{m-wf-id}/workflow/{wf-id}/files

Retrieve all workflow files

Returns a collection of the WorkflowFiles resource.

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID

Query Parameters:

query (string) – A query to filter out records. See: Querying
order (string) – Result sorting criteria. See: Ordering
start-index (integer) – Return results starting from record <start-index> (0 indexed)
max-results (integer) – Max no. of records to return
pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
204 No Content – No content
400 Bad Request – Bad request
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
default – Internal server error

Response JSON Object:

[].lfn (string)
[].lfn_id (integer)
[].meta[].key (string)
[].meta[].meta_id (integer)
[].meta[].value (string)
[].pfns[].pfn (string)
[].pfns[].pfn_id (integer)
[].pfns[].site (string)
[].wf_id (integer)

GET /root/{m-wf-id}/workflow/{wf-id}/state

Retrieve workflow’s states

Returns a collection of the Workflow State resource

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID

Query Parameters:

query (string) – A query to filter out records. See: Querying
order (string) – Result sorting criteria. See: Ordering
start-index (integer) – Return results starting from record <start-index> (0 indexed)
max-results (integer) – Max no. of records to return
pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
204 No Content – No content
400 Bad Request – Bad request
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
default – Internal server error

Response JSON Object:

[].restart_count (integer)
[].state (string)
[].status (integer)
[].timestamp (number)
[].wf_id (integer)

GET /root/{m-wf-id}/workflow/{wf-id}/host

Retrieve all hosts on which a workflows job ran on

Returns a collection of the Host resource

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID

Query Parameters:

query (string) – A query to filter out records. See: Querying
order (string) – Result sorting criteria. See: Ordering
start-index (integer) – Return results starting from record <start-index> (0 indexed)
max-results (integer) – Max no. of records to return
pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
204 No Content – No content
400 Bad Request – Bad request
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
default – Internal server error

Response JSON Object:

[].host_id (integer)
[].hostname (string)
[].ip (string)
[].site_name (string)
[].total_memory (string)
[].uname (string)

GET /root/{m-wf-id}/workflow/{wf-id}/host/{host-id}

Retrieve a host

Returns a Host resource identified by m_wf_id, wf_id, host_id

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID
host-id (integer) – Host Id

Query Parameters:

pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
404 Not Found – Not found
default – Internal server error

Response JSON Object:

[].host_id (integer)
[].hostname (string)
[].ip (string)
[].site_name (string)
[].total_memory (string)
[].uname (string)

GET /root/{m-wf-id}/workflow/{wf-id}/task

Retrieve all workflow tasks

Returns a collection of the Task resource

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID

Query Parameters:

query (string) – A query to filter out records. See: Querying
order (string) – Result sorting criteria. See: Ordering
start-index (integer) – Return results starting from record <start-index> (0 indexed)
max-results (integer) – Max no. of records to return
pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
204 No Content – No content
400 Bad Request – Bad request
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
default – Internal server error

Response JSON Object:

[].abs_task_id (string)
[].argv (string)
[].task_id (integer)
[].transformation (string)
[].type_desc (string)

GET /root/{m-wf-id}/workflow/{wf-id}/task/{task-id}

Retrieve a workflow’s task

Returns a Task resource identified by m_wf_id, wf_id, task_id

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID
task-id (integer) – Task Id

Query Parameters:

pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
404 Not Found – Not found
default – Internal server error

Response JSON Object:

[].abs_task_id (string)
[].argv (string)
[].task_id (integer)
[].transformation (string)
[].type_desc (string)

GET /root/{m-wf-id}/workflow/{wf-id}/task/{task-id}/meta

Retrieve all task metadata

Returns a collection of the TaskMetadata resource

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID
task-id (integer) – Task Id

Query Parameters:

query (string) – A query to filter out records. See: Querying
order (string) – Result sorting criteria. See: Ordering
start-index (integer) – Return results starting from record <start-index> (0 indexed)
max-results (integer) – Max no. of records to return
pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
204 No Content – No content
400 Bad Request – Bad request
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
default – Internal server error

Response JSON Object:

[].key (string)
[].task_id (integer)
[].value (string)

GET /root/{m-wf-id}/workflow/{wf-id}/invocation

Retrieve all workflow invocations

Returns a collection of the Invocation resource

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID

Query Parameters:

query (string) – A query to filter out records. See: Querying
order (string) – Result sorting criteria. See: Ordering
start-index (integer) – Return results starting from record <start-index> (0 indexed)
max-results (integer) – Max no. of records to return
pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
204 No Content – No content
400 Bad Request – Bad request
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
default – Internal server error

Response JSON Object:

[].abs_task_id (string)
[].argv (string)
[].executable (string)
[].exitcode (integer)
[].invocation_id (integer)
[].job_instance_id (integer)
[].remote_cpu_time (number)
[].remote_duration (number)
[].start_time (number)
[].task_submit_seq (integer)
[].transformation (string)

GET /root/{m-wf-id}/workflow/{wf-id}/invocation/{invocation-id}

Retrieve a workflow invocation

Returns a Invocation resource identified by m_wf_id, wf_id, invocation_id

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID
invocation-id (integer) – Invocation Id

Query Parameters:

pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
404 Not Found – Not found
default – Internal server error

GET /root/{m-wf-id}/workflow/{wf-id}/job

Retrieve all workflows jobs

Returns a collection of the Job resource

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID

Query Parameters:

query (string) – A query to filter out records. See: Querying
order (string) – Result sorting criteria. See: Ordering
start-index (integer) – Return results starting from record <start-index> (0 indexed)
max-results (integer) – Max no. of records to return
pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
204 No Content – No content
400 Bad Request – Bad request
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
default – Internal server error

Response JSON Object:

[].argv (string)
[].clustered (boolean)
[].exec_job_id (string)
[].executable (string)
[].job_id (integer)
[].max_retries (integer)
[].submit_file (string)
[].task_count (integer)
[].type_desc (string)

GET /root/{m-wf-id}/workflow/{wf-id}/job/{job-id}

Retrieve a workflow job

Returns a Job resource identified by m_wf_id, wf_id, job_id

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID
job-id (integer) – job Id

Query Parameters:

pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
404 Not Found – Not found
default – Internal server error

Response JSON Object:

[].argv (string)
[].clustered (boolean)
[].exec_job_id (string)
[].executable (string)
[].job_id (integer)
[].max_retries (integer)
[].submit_file (string)
[].task_count (integer)
[].type_desc (string)

GET /root/{m-wf-id}/workflow/{wf-id}/job/{job-id}/task

Retrieve all job tasks

Returns a collection of the Task resource

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID
job-id (integer) – job Id

Query Parameters:

query (string) – A query to filter out records. See: Querying
order (string) – Result sorting criteria. See: Ordering
start-index (integer) – Return results starting from record <start-index> (0 indexed)
max-results (integer) – Max no. of records to return
pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
204 No Content – No content
400 Bad Request – Bad request
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
default – Internal server error

Response JSON Object:

[].abs_task_id (string)
[].argv (string)
[].task_id (integer)
[].transformation (string)
[].type_desc (string)

GET /root/{m-wf-id}/workflow/{wf-id}/job/{job-id}/job-instance

Retrieve all job’s job instances

Returns a collection of the Job Instance resource

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID
job-id (integer) – job Id

Query Parameters:

query (string) – A query to filter out records. See: Querying
order (string) – Result sorting criteria. See: Ordering
start-index (integer) – Return results starting from record <start-index> (0 indexed)
max-results (integer) – Max no. of records to return
recent (boolean) – Get most recent record.
pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
204 No Content – No content
400 Bad Request – Bad request
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
default – Internal server error

Response JSON Object:

[].cluster_duration (number)
[].cluster_start (number)
[].exitcode (string)
[].host_id (integer)
[].job_instance_id (integer)
[].job_submit_seq (integer)
[].local_duration (number)
[].multiplier_factor (string)
[].sched_id (string)
[].site_name (string)
[].stderr_file (string)
[].stderr_text (string)
[].stdin_file (string)
[].stdout_file (string)
[].stdout_text (string)
[].subwf_id (integer)
[].user (string)
[].work_dir (string)

GET /root/{m-wf-id}/workflow/{wf-id}/job/{job-id}/job-instance/{job-instance-id}

Retrieve a job’s job instance

Returns a Job Instance resource identified by m_wf_id, wf_id, job_id, job_instance_id

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID
job-id (integer) – job Id
job-instance-id (integer) – job-instance Id

Query Parameters:

pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
404 Not Found – Not found
default – Internal server error

Response JSON Object:

[].cluster_duration (number)
[].cluster_start (number)
[].exitcode (string)
[].host_id (integer)
[].job_instance_id (integer)
[].job_submit_seq (integer)
[].local_duration (number)
[].multiplier_factor (string)
[].sched_id (string)
[].site_name (string)
[].stderr_file (string)
[].stderr_text (string)
[].stdin_file (string)
[].stdout_file (string)
[].stdout_text (string)
[].subwf_id (integer)
[].user (string)
[].work_dir (string)

GET /root/{m-wf-id}/workflow/{wf-id}/job/{job-id}/job-instance/{job-instance-id}/state

Retrieve all job states

Returns a collection of the Job State resource

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID
job-id (integer) – job Id
job-instance-id (integer) – job-instance Id

Query Parameters:

query (string) – A query to filter out records. See: Querying
order (string) – Result sorting criteria. See: Ordering
start-index (integer) – Return results starting from record <start-index> (0 indexed)
max-results (integer) – Max no. of records to return
pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
204 No Content – No content
400 Bad Request – Bad request
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
default – Internal server error

Response JSON Object:

[].job_instance_id (integer)
[].jobstate_submit_seq (string)
[].state (string)
[].timestamp (number)

GET /root/{m-wf-id}/workflow/{wf-id}/job/{job-id}/job-instance/{job-instance-id}/invocation

Retrieve all job invocations

Returns a collection of the Invocation resource

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID
job-id (integer) – job Id
job-instance-id (integer) – job-instance Id

Query Parameters:

query (string) – A query to filter out records. See: Querying
order (string) – Result sorting criteria. See: Ordering
start-index (integer) – Return results starting from record <start-index> (0 indexed)
max-results (integer) – Max no. of records to return
pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
204 No Content – No content
400 Bad Request – Bad request
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
default – Internal server error

Response JSON Object:

[].abs_task_id (string)
[].argv (string)
[].executable (string)
[].exitcode (integer)
[].invocation_id (integer)
[].job_instance_id (integer)
[].remote_cpu_time (number)
[].remote_duration (number)
[].start_time (number)
[].task_submit_seq (integer)
[].transformation (string)

GET /root/{m-wf-id}/workflow/{wf-id}/job/running

Retrieve a workflow’s running jobs

Returns a collection of running Job resource. Note: Queries, Sorting can include fields from Job and JobInstance resource

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID

Query Parameters:

query (string) – A query to filter out records. See: Querying
order (string) – Result sorting criteria. See: Ordering
start-index (integer) – Return results starting from record <start-index> (0 indexed)
max-results (integer) – Max no. of records to return
pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
204 No Content – No content
400 Bad Request – Bad request
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
default – Internal server error

Response JSON Object:

[].argv (string)
[].clustered (boolean)
[].exec_job_id (string)
[].executable (string)
[].job_id (integer)
[].max_retries (integer)
[].submit_file (string)
[].task_count (integer)
[].type_desc (string)

GET /root/{m-wf-id}/workflow/{wf-id}/job/succesful

Retrieve a workflow’s successful jobs

Returns a collection of successful Job resource. Note: Queries, Sorting can include fields from Job and JobInstance resource

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID

Query Parameters:

query (string) – A query to filter out records. See: Querying
order (string) – Result sorting criteria. See: Ordering
start-index (integer) – Return results starting from record <start-index> (0 indexed)
max-results (integer) – Max no. of records to return
pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
204 No Content – No content
400 Bad Request – Bad request
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
default – Internal server error

Response JSON Object:

[].argv (string)
[].clustered (boolean)
[].exec_job_id (string)
[].executable (string)
[].job_id (integer)
[].max_retries (integer)
[].submit_file (string)
[].task_count (integer)
[].type_desc (string)

GET /root/{m-wf-id}/workflow/{wf-id}/job/failed

Retrieve a workflow’s failed jobs

Returns a collection of failed Job resource. Note: Queries, Sorting can include fields from Job and JobInstance resource

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID

Query Parameters:

query (string) – A query to filter out records. See: Querying
order (string) – Result sorting criteria. See: Ordering
start-index (integer) – Return results starting from record <start-index> (0 indexed)
max-results (integer) – Max no. of records to return
pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
204 No Content – No content
400 Bad Request – Bad request
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
default – Internal server error

Response JSON Object:

[].argv (string)
[].clustered (boolean)
[].exec_job_id (string)
[].executable (string)
[].job_id (integer)
[].max_retries (integer)
[].submit_file (string)
[].task_count (integer)
[].type_desc (string)

GET /root/{m-wf-id}/workflow/{wf-id}/failing/job

Retrieve a workflow’s failing jobs

Returns a collection of failing Job resource. Note: Queries, Sorting can include fields from Job and JobInstance resource

Parameters:

m-wf-id (string) – Master Workflow’s ID or UUID
wf-id (string) – Workflow’s ID or UUID

Query Parameters:

query (string) – A query to filter out records. See: Querying
order (string) – Result sorting criteria. See: Ordering
start-index (integer) – Return results starting from record <start-index> (0 indexed)
max-results (integer) – Max no. of records to return
pretty-print (boolean) – Enable or disable pretty printing of the output

Status Codes:

200 OK – Success
204 No Content – No content
400 Bad Request – Bad request
401 Unauthorized – Not authenticated
403 Forbidden – Not authorized
default – Internal server error

Response JSON Object:

[].argv (string)
[].clustered (boolean)
[].exec_job_id (string)
[].executable (string)
[].job_id (integer)
[].max_retries (integer)
[].submit_file (string)
[].task_count (integer)
[].type_desc (string)

1.4.3. Querying

Querying is supported through query string argument query.

Querying is supported only on endpoints returning collections.

1.4.3.1. Syntax

Query clauses are rudimentary and must follow some rules.

Supported comparators are ==, !=, <, <=, >, >=, in.
Supported operators are and, or, not.
Supported functions like, ilike.
Comparision clauses must have the form <FIELDNAME> SPACE <COMPARATOR> SPACE <STRING LITERAL OR INTEGER LITERAL OR FLOAT LITERAL>
<FIELDNAME> must be prefixed with resource query prefix Example: r.wf_id is valid, but wf_id is not.
<FIELDNAMES> which can be used in a query caluse depends on the resource being queries. Example: For endpoint /api/v1/user/user-a/root/1/workflow/1/job/2/state query clause can only contain fields from the Job State resource.
Only exceptions for the previous rules are

Querying Root Workflow where fields from both Root Workflow and Workflow State can be included.

Querying the /api/v1/user/user-a/root/1/workflow/1/files where fields from RC LFN, RC PFN, an RC Metadata can be included.

Views endpoint /api/v1/user/user-a/root/1/workflow/1/job/<[running|successful|failed|failing]> where fields from Job and JobInstance resource can be included.

Example

For Root Workflow https://www.domain.com/api/v1/user/user-a/root?query<QUERY>

Where QUERY can be( r.wf_id >= 5 AND r.planner_version.like( '4.5%' ) OR ( r.wf_id in ( 1, 2 ) )

1.4.3.2. Resource - Query Prefix

Query Prefix
Resource	Query Prefix	Example
Root Workflow	r	r.wf_id
Workflow	w	w.wf_uuid
Workflow Metadata	wm	wm.key
Workflow Files	wf	wf.lfn
Workflow State	ws	ws.state
Job	j	j.type_desc
Host	h	h.site
Job State	js	js.state
Task	t	t.abs_task_id
Task Metadata	tm	tm.value
Job Instance	ji	ji.exitcode
Invocation	i	i.argv
RC LFN	l	l.lfn
RC PFN	p	p.pfn
RC Metadata	rm	rm.key

1.4.3.3. Recent

Job Instance resources have historical records.

For use cases where developers need to get the most recent record, we set query argument recent to true.

1.4.4. Ordering

Ordering is supported through query string argument order.

Ordering is supported only on endpoints returning collections.

Order clause can only contain fields which are part of the resource being returned. Fields must be prefixed by the Resource Query Prefix

Example: Order clause for an endpoint returning a Workflow resource can only contain fields that are part of the Workflow resource.

1.4.4.1. Syntax

Order clause consists of one or more field names optionally prefixed by a “+” to denote ascending or “-” to denote sorting direction, separated by commas.

https://www.domain.com/api/v1/user/user-a/root?order=r.submit_hostname,-r.wf_id

1.4.5. Examples

1.4.5.1. Resource - Single

$ curl --request GET \
       --user user-a:user-a-password \
       https://www.domain.com/api/v1/user/user-a/root/1/workflow/1?pretty-print=true


HTTP/1.1 200 OK

{
    "wf_id"             : 1,
    "root_wf_id"        : 1,
    "parent_wf_id"      : null,
    "wf_uuid"           : "7193de8c-a28d-4eca-b576-1b1c3c4f668b",
    "submit_hostname"   : "isis.isi.edu",
    "submit_dir"        : "/home/tutorial/submit/",
    "planner_arguments" : "--conf pegasusrc --sites condorpool --output-site local --dir dags --dax dax.xml --submit",
    "planner_version"   : "4.5.0dev",
    "user"              : "user-a",
    "grid_dn"           : null,
    "dax_label"         : "hello_world",
    "dax_version"       : "3.5",
    "dax_file"          : "/home/tutorial/hello-world.xml",
    "dag_file_name"     : "hello_world-0.dag",
    "timestamp"         : 1421432530.0
}

1.4.5.2. Resource - Collection

$ curl --request GET \
       --user user-a:user-a-password \
       https://www.domain.com/api/v1/user/user-a/root/1/workflow?pretty-print=true

HTTP/1.1 200 OK

{
    "records" : [
        {
            "wf_id"             : 1,
            "root_wf_id"        : 1,
            "parent_wf_id"      : null,
            "wf_uuid"           : "7193de8c-a28d-4eca-b576-1b1c3c4f668b",
            "submit_hostname"   : "isis.isi.edu",
            "submit_dir"        : "/home/tutorial/dags/20150116T102210-0800",
            "planner_arguments" : "--conf pegasusrc --sites condorpool --output-site local --dir dags  --dax dax.xml --submit",
            "planner_version"   : "4.5.0dev",
            "user"              : "user-a",
            "grid_dn"           : null,
            "dax_label"         : "hello_world",
            "dax_version"       : "3.5",
            "dax_file"          : "/home/tutorial/hello-world.xml",
            "dag_file_name"     : "hello_world-0.dag",
            "timestamp"         : 1421432530.0
        },
        {
            "wf_id"             : 2,
            "root_wf_id"        : 2,
            "parent_wf_id"      : null,
            "wf_uuid"           : "41920a57-7882-4990-854e-658b7a797745",
            "submit_hostname"   : "isis.isi.edu",
            "submit_dir"        : "/home/tutorial/dags/20150330T165231-0700",
            "planner_arguments" : "--conf pegasusrc --sites condorpool --output-site local --dir dags --dax dax.xml --submit",
            "planner_version"   : "4.5.0dev",
            "user"              : "user-a",
            "grid_dn"           : null,
            "dax_label"         : "hello_world",
            "dax_version"       : "3.5",
            "dax_file"          : "/home/tutorial/hello-world.xml",
            "dag_file_name"     : "hello_world-0.dag",
            "timestamp"         : 1427759551.0
        },
        {
            "wf_id"             : 3,
            "root_wf_id"        : 3,
            "parent_wf_id"      : null,
            "wf_uuid"           : "fce67b41-df67-4b3c-8fa4-d77e6e2b9769",
            "submit_hostname"   : "isis.isi.edu",
            "submit_dir"        : "/home/tutorial/dags/20150330T170228-0700",
            "planner_arguments" : "--conf pegasusrc --sites condorpool --output-site local --dir dags --dax dax.xml --submit",
            "planner_version"   : "4.5.0dev",
            "user"              : "user-a",
            "grid_dn"           : null,
            "dax_label"         : "hello_world",
            "dax_version"       : "3.5",
            "dax_file"          : "/home/tutorial/hello-world.xml",
            "dag_file_name"     : "hello_world-0.dag",
            "timestamp"         : 1427760148.0
        }
    ],
    "_meta"   : {
        "records_total"    : 3,
        "records_filtered" : 3
    }
}

1.4.5.3. Querying

$ curl --request GET \
       --get \
       --data-urlencode "pretty-print=true" \
       --data-urlencode "query=w.wf_uuid == '41920a57-7882-4990-854e-658b7a797745'" \
       --user user-a:user-a-password \
       https://www.domain.com/api/v1/user/user-a/root/1/workflow

HTTP/1.1 200 OK

{
    "records" : [
        {
            "wf_id"             : 2,
            "root_wf_id"        : 2,
            "parent_wf_id"      : null,
            "wf_uuid"           : "41920a57-7882-4990-854e-658b7a797745",
            "submit_hostname"   : "isis.isi.edu",
            "submit_dir"        : "/home/tutorial/dags/20150330T165231-0700",
            "planner_arguments" : "--conf pegasusrc --sites condorpool --output-site local --dir dags --dax dax.xml --submit",
            "planner_version"   : "4.5.0dev",
            "user"              : "user-a",
            "grid_dn"           : null,
            "dax_label"         : "hello_world",
            "dax_version"       : "3.5",
            "dax_file"          : "/home/tutorial/hello-world.xml",
            "dag_file_name"     : "hello_world-0.dag",
            "timestamp"         : 1427759551.0
        }
    ],
    "_meta"   : {
        "records_total"    : 3,
        "records_filtered" : 1
    }
}

1.4.5.4. Ordering

$ curl --request GET \
       --user user-a:user-a-password \
       https://www.domain.com/api/v1/user/user-a/root/1/workflow?pretty-print=true&order=-w.wf_id

HTTP/1.1 200 OK

{
    "records" : [
        {
            "wf_id"             : 3,
            "root_wf_id"        : 3,
            "parent_wf_id"      : null,
            "wf_uuid"           : "fce67b41-df67-4b3c-8fa4-d77e6e2b9769",
            "submit_hostname"   : "isis.isi.edu",
            "submit_dir"        : "/home/tutorial/dags/20150330T170228-0700",
            "planner_arguments" : "--conf pegasusrc --sites condorpool --output-site local --dir dags --dax dax.xml --submit",
            "planner_version"   : "4.5.0dev",
            "user"              : "user-a",
            "grid_dn"           : null,
            "dax_label"         : "hello_world",
            "dax_version"       : "3.5",
            "dax_file"          : "/home/tutorial/hello-world.xml",
            "dag_file_name"     : "hello_world-0.dag",
            "timestamp"         : 1427760148.0
        },
        {
            "wf_id"             : 2,
            "root_wf_id"        : 2,
            "parent_wf_id"      : null,
            "wf_uuid"           : "41920a57-7882-4990-854e-658b7a797745",
            "submit_hostname"   : "isis.isi.edu",
            "submit_dir"        : "/home/tutorial/dags/20150330T165231-0700",
            "planner_arguments" : "--conf pegasusrc --sites condorpool --output-site local --dir dags --dax dax.xml --submit",
            "planner_version"   : "4.5.0dev",
            "user"              : "user-a",
            "grid_dn"           : null,
            "dax_label"         : "hello_world",
            "dax_version"       : "3.5",
            "dax_file"          : "/home/tutorial/hello-world.xml",
            "dag_file_name"     : "hello_world-0.dag",
            "timestamp"         : 1427759551.0
        },
        {
            "wf_id"             : 1,
            "root_wf_id"        : 1,
            "parent_wf_id"      : null,
            "wf_uuid"           : "7193de8c-a28d-4eca-b576-1b1c3c4f668b",
            "submit_hostname"   : "isis.isi.edu",
            "submit_dir"        : "/home/tutorial/dags/20150116T102210-0800",
            "planner_arguments" : "--conf pegasusrc --sites condorpool --output-site local --dir dags  --dax dax.xml --submit",
            "planner_version"   : "4.5.0dev",
            "user"              : "user-a",
            "grid_dn"           : null,
            "dax_label"         : "hello_world",
            "dax_version"       : "3.5",
            "dax_file"          : "/home/tutorial/hello-world.xml",
            "dag_file_name"     : "hello_world-0.dag",
            "timestamp"         : 1421432530.0
        }
    ],
    "_meta"   : {
        "records_total"    : 3,
        "records_filtered" : 3
    }
}