Workflow

Base definition

{
    "kind": "workflow",
    "id": string,
    "qualifiedReference": string,
    "scopedReference": string,
    "referenceId": string,
    "name": string,
    "url": string,
    "uri": string,
    "owner": {
        user.base | organization.base // See user or organization resource definition
    }
}

List definition

In addition to the base definition, any workflow resource returned by a list request will contain the following properties:

{
    "createdAt": integer, 
    "publicAccessLevel": string("none"|"view"),
    "studyAccessLevel": string("none"|"view") | null,
    "accessLevel": string("view"|"edit"),
    "study": {
        "kind": "study",
        "name": string
    } | null
}

Get definition

In addition to the base and list definition, any workflow resource returned by a get request will contain the following properties:

{
    "lastActive": integer,
    "tableCount": integer,
    "transformCount": integer,
    "notebookCount": integer,
    "description": string,
}

Documentation

Fields
Base
kind	string The resource type. Will always be "workflow"
id	string A unique, persistent identifier for the dataset.
qualifiedReference	string The fully qualified reference for the workflow, of the form username.workflow_reference. E.g., imathews.example_workflow_climate_analysis:x7kh
scopedReference	string The canonical reference for the workflow, e.g., example_workflow_climate_analysis:x7kh
referenceId	string A persistent, 4-character identifier for this workflow. Will always be unique across all workflows owned by the user.
name	string The name of the workflow
url	string The workflow's url resolvable via the web interface.
uri	string The fully qualified URI of the workflow, for use in generating calls to this API. For example, /workflows/imathews.example_workflow_climate_analysis:x7kh
owner	object The owner of the workflow. Will either be an organization base definition or a user base definition.
List
createdAt	integer When the dataset was created. Stored as milliseconds since the epoch (1970-01-01).
publicAccessLevel	string The access level to the workflow for any user / all non-authenticated users. Will be one of "none"|"view" Users with access to a workflow will still only be able to see data derivatives that they have access to.
studyAccessLevel	string | null The access level to the workflow for any member of the workflow's study. If the workflow has a study, will be one of "none"|"view"|"edit". Otherwise, will be null.
accessLevel	string | null Your access level to the workflow. Will be one of "view"|"edit".
study	object | null This workflow's study
study.kind	string Will always be "study"
study.name	string The name of the study
Get
lastActive	integer When the workflow was last active, defined as a node in the workflow being run. Stored as milliseconds since the epoch (1970-01-01).
description	string A user-provided description of the dataset. Corresponds to the "abstract" show on the dataset overview.
tableCount	integer The number of tables created in the workflow.
transformCount	integer The number of transforms in the workflow.
notebookCount	integer The number of notebooks in the workflow