billTo
for the global workflow./globalworkflow/new
resources
option. In addition, the workflow object defined under regionalOptions
and the applets (together with their assets) that are defined in the workflow stages are copied into it. Developers of the global workflow have VIEW access to the resources container. After the workflow is published, the authorized users will also have VIEW access to this container.billTo
will default to the billTo
of the requesting user (this is the same default billing account for new projects created by the user) unless otherwise specified. This same billing account must be used for all subsequent versions created under the same global workflow name.name
, version
, regionalOptions
(pointing to least one workflow
ID in one region) are required. The set of enabled regions of a particular version will be the keys of the regionalOptions
mapping. The set of enabled regions is fixed once the version is created.regionalOptions
mapping Configurations for all regions (e.g., "aws:us-east-1", "azure:westus") in which this global workflow will be enabledworkflow
string ID of the underlying workflow of this global workflow in the corresponding region. It is a regular workflow, stored in any project as a data-object. The I/O specifications of all specified underlying workflow must be equalname
string Name for the global workflow, e.g. "micromap". Must match /^[a-zA-Z0-9._-]+$/ and cannot start with the prefix "app-" or "globalworkflow-". See Name and version.version
string A nonempty freeform string representing the global workflow’s version; must be unique for the given global name (string provided must match /^[a-zA-Z0-9._+-]+$/). See Name and version.title
string (optional) Title for the global workflow, e.g. "Micro Map". If no title (or an empty string) is found, then name
is used as the titlesummary
string (optional) A one-line description for the global workflowdescription
string (optional) A longer description of the workflow, formatted in Markdown, to be displayed on the workflow's detail page)developerNotes
string (optional) More advanced documentation for the global workflowbillTo
string (optional, default is billTo
of the requesting user issuing the API call) ID of the entity to which all resource/storage costs associated with this global workflow will be billed; must be the ID of the requesting user or an org of which the requesting user is a member with allowBillableActivities
permission. If this is a subsequent version of an existing global workflow, then billTo
must be the same as billTo
of the existing global workflownonce
string (optional) Unique identifier (idempotency token) for this request. Ensures that even if multiple requests fail and are retried, only a single global workflow is created. For more information, see Nonces.costLimit
float (optional) The limit of the cost this global workflow should accrue before termination. This field will be ignored if global workflow is not a root execution.id
string ID of this workflow (of the form "globalworkflow-<hash id>").resourcesByRegion
mapping Mapping of the resources containers created for this workflow.regionalOptions
is specified, then it must be non-empty.workflow
is specified for one region in regionalOptions
, then it must be specified for all regions.regionalOptions[r].workflow
(where r
is a region name) must reside in the region denoted by r
version
is already in use by an existing version of this global workflows, or is a tag
for a published version of this workflow.nonce
was reused in a request but some of the other inputs had changed signifying a new and different requestnonce
may not exceed 128 bytesname
provided is in use, then the user must also be listed as a developer for the namebillTo
must be either the ID of the requesting user or the ID of an org of which the requesting user is a member with allowBillableActivities
permissionbillTo
of the invoking user is an org and the user is no longer a member of that orgpermittedRegions
of this global workflows's billTo
billTo
has reached its spending limit/globalworkflow-xxxx[/yyyy]/update
title
string (optional) The global workflow’s title, e.g. "Micro Map"summary
string (optional) The global workflow’s summarydescription
string (optional) The global workflow’s descriptiondeveloperNotes
string (optional) Advanced documentation for the global workflowid
string ID of the global workflow (of the form "globalworkflow-<hash id>")/globalworkflow-xxxx[/yyyy]/addTags
/globalworkflow-foo/2.0.0/addTags
with input {"tags":["default"]}
tags
array of strings List of tags to add to the specified global workflowid
string ID of the workflow (of the form "globalworkflow-<hash id>")tags
is not present or is not an array of nonempty strings, a tag is equal to an existing version, whether published or not/globalworkflow-xxxx[/yyyy]/removeTags
tags
array of strings List of tags to remove from all versions of the global workflowname
string Global workflow name modified (e.g. "bwa")tags
is not present or is not an array of nonempty strings, a tag is equal to an existing version, or the tag includes the special tag "default"/globalworkflow-xxxx[/yyyy]/publish
makeDefault
boolean (optional, default false) Whether this global workflow should take on the "default" tag, removing it from whichever workflow version was previously marked as "default"id
string ID of the workflow (of the form "globalworkflow-<hash id>")/globalworkflow-xxxx[/yyyy]/describe
fields
mapping (optional) Restrict the output of this method to have only the provided keys in this fieldid
string ID of the global workflow (of the form "globalworkflow-<hash id>")class
string The value "globalworkflow"billTo
string ID of the user/organization that owns this global workflow's name (and is billed for the storage incurred by the workflow versions)name
string Name of the workflowtitle
string Freeform nameversion
string Version of the workflowaliases
array of strings List that includes the version and all tags of this workflow by which it can be addressed using "globalworkflow-/"summary
string A one-line description of the workflowdescription
string A long description of the workflow, formatted in Markdown, to be displayed on the workflow's detail pagecategories
array of strings List of categories the workflow belongs todxapi
string The version of the API usedcreatedBy
string ID of the user who created the workflowcreated
timestamp When the workflow was createdmodified
timestamp When this workflow was last modifieddeleted
boolean Whether the workflow has been deletedisDeveloperFor
boolean Whether the requesting user has developer permissions for the workflow AND the token provided has full scope or has developer accessauthorizedUsers
array of strings List of user and org IDs representing who can describe and run this workflow; if the string "PUBLIC" is present, then all users can access this workflowregionalOptions
mapping Mapping that contains the regional configurations for this workflowworkflow
string ID of the underlying workflow of this global workflow in the corresponding region.resources
string ID of the resources container of this global workflow in the corresponding region. It contains the underlying workflow and any other dependencies (files, applets).published
timestamp Time at which this workflow was publishedfields
if present, is not a hash or has a non-boolean key/globalworkflow-xxxx[/yyyy]/run
name
name (optional, default is the global workflow's title if set and otherwise its name) Name for the resulting analysisinput
mapping Input that the global workflow is launched withproject
string (required if invoked by a user; optional if invoked from a job with detach: true
option; prohibited when invoked from a job with detach: false
) The ID of the project in which this global workflow will be run (i.e., the project context). If invoked with the detach: true
option, then the detached analysis will run under the provided project
(if provided), otherwise project context is inherited from that of the invoking job. If invoked by a user or run as detached, all output objects are cloned into the project context; otherwise, all output objects will be cloned into the temporary workspace of the invoking job. See The Project Context and Temporary Workspace for more information.folder
string (optional) The folder into which objects output by the analysis will be placed. If the folder does not exist when the job(s) complete, it (and any parent folders necessary) will be created. See the Customizing Output Folders for more details on how it interacts with stages' output foldersstageFolders
mapping (optional) Override any stored options for the workflow stages' folder
fields. See the Customizing Output Folders section for more detailsdetails
array or mapping (optional, default { }) Any conformant JSON (i.e. a JSON object or array, per RFC4627), which will be stored with the created jobnonce
string (optional) Unique identifier for this request. Ensures that even if multiple requests fail and are retried, only a single analysis is created. For more information, see Nonces.tags
array of strings (optional) Tags to associate with the resulting analysisproperties
mapping (optional) Properties to associate with the resulting analysisdetails
mapping or array (optional, default { }) JSON object or array that is to be associated with the analysisdetach
boolean (optional) This option has no impact when the API is invoked by a user. If invoked from a job with detach set to true, the new analysis will be detached from the creator job and will appear as a typical root execution. A failure in the detached analysis will not cause a termination of the job from which it was created and vice versa. Detached analysis will not inherit access to the workspace of its creator job. Detached analysis' access permissions will be the intersection (most restricted) of access permissions of the creator job and the permissions requested by jobs' executables in the detached analysis. To launch the detached analysis, creator job must have CONTRIBUTE or higher access to the project in which the detached job is launched. Additionally, the billTo of the project in which the creator job is running must be licensed to launch detached executions.rank
integer (optional) An integer between -1024 and 1023, inclusive. The rank indicates the priority in which the executions generated from this executable will be processed. The higher the rank, the more prioritized it will be. If no rank is provided, the executions default to a rank of zero. If the execution is not a root execution, it will inherit its parent's rank. If a rank is provided, all executions relating to the workflow stages will also inherit the rank.id
string ID of the created analysis object (i.e. a string in the form “analysis-xxxx”).stages
array of strings List of job IDs that will be created for each stage, as ordered in the workflowallowSSH
or debug
options, the user must have developer access to all apps in the workflow, or the apps must have the openSource
field set to truebillTo
of the job's project must be licensed to start detached executions when invoked from the job with detach: true
argument.nonce
was reused in a request but some of the other inputs had changed signifying a new and different requestnonce
may not exceed 128 bytes/globalworkflow-xxxx[/yyyy]/delete
id
string ID of the workflow (of the form "globalworkflow-<hash id>")/globalworkflow-xxxx[/yyyy]/addDevelopers
billTo
of the workflow or the billTo
of the workflow is an org and the user is an ADMIN of that org, then the user may invoke this method to grant themselves, and only themselves, developer access to the workflow.developers
array of strings List of user and/or org IDs that will be added as developersname
string The global workflow name (e.g. "bwa")billTo
of the workflow, then developers
may only contain the ID of the requesting userbillTo
of the workflowbillTo
of the workflow, then the user must have a full scope token/globalworkflow-xxxx[/yyyy]/listDevelopers
developers
array of strings List of user and/or org IDs that/globalworkflow-xxxx[/yyyy]/removeDevelopers
developers
array of strings list of user and/or org IDs that will be removed as developersname
string the global workflow name (e.g. "bwa")developers
contains that user ID/globalworkflow-xxxx[/yyyy]/addAuthorizedUsers
authorizedUsers
array of strings List of user and/or org IDs to add to the access listname
string The global workflow name (e.g. "bwa")authorizedUsers
is missing or is not an array of nonempty strings/globalworkflow-xxxx[/yyyy]/listAuthorizedUsers
authorizedUsers
array of strings List of user and/or org IDs that can describe and run the workflow; if "PUBLIC" is present, this means all users can access the workflow./globalworkflow-xxxx[/yyyy]/removeAuthorizedUsers
authorizedUsers
array of strings List of user and/or org IDs to remove from the access listname
string The global workflow name (e.g. "bwa")authorizedUsers
is missing or is not an array of nonempty strings/globalworkflow-xxxx[/yyyy]/addCategories
categories
array of strings List of categories to add thename
string The global workflow name (e.g. "bwa")categories
is missing or is not an array of nonempty strings, a listed category is not allowed: "new", "recommended", or "popular"/globalworkflow-xxxx[/yyyy]/listCategories
categories
array of strings List of categories the global workflow belongs to/globalworkflow-xxxx[/yyyy]/removeCategories
categories
array of strings List of categories (strings) to remove from the global workflowname
string The global workflow name (e.g. "bwa")categories
is missing or is not an array of nonempty strings