Skip to main content

Workflow

A workflow definition.

type Workflow {
  id: ID!
  name: String!
  displayName: String!
  namespace: String!
  defaultVariant: WorkflowVariant
  variants: [WorkflowVariant!]!
  executions: [WorkflowExecution!]!
  inputs: [WorkflowInput!]!
  executionEligibility: ExecutionEligibility
  addInName: String
  addInDocUrl: String
  description: String!
  createdAt: DateTime
  createdBy: User
  visibleInRunner: Boolean!
}

Fields​

Workflow.id ● ID! non-null scalar​

The workflow's ID.

Workflow.name ● String! non-null scalar​

The workflow name.

Workflow.displayName ● String! non-null scalar​

The display name of the workflow.

Workflow.namespace ● String! non-null scalar​

The workflow namespace. The workflow permissions are granted via namespace.

Workflow.defaultVariant ● WorkflowVariant object​

The default variant for a workflow. It doesn't have to have one.

Workflow.variants ● [WorkflowVariant!]! non-null object​

All the possible variants available for this workflow.

Workflow.executions ● [WorkflowExecution!]! non-null object​

All the associated workflow executions.

Workflow.inputs ● [WorkflowInput!]! non-null object​

All workflow inputs

Workflow.executionEligibility ● ExecutionEligibility object​

Indicates if the workflow can be executed

Workflow.addInName ● String scalar​

Optional name of an add in if workflow belongs to one

Workflow.addInDocUrl ● String scalar​

Optional URL to the add-in documentation, if the workflow belongs to an add-in

Workflow.description ● String! non-null scalar​

Workflow description

Workflow.createdAt ● DateTime scalar​

Time when workflow was created

Workflow.createdBy ● User object​

User who created the workflow

Workflow.visibleInRunner ● Boolean! non-null scalar​

Whether this workflow is visible in the automation runner. Resolves the per-workflow flag against the system default when the flag is not explicitly set.

Returned By​

workflow query ● workflowById query ● workflows query

Member Of​

StartDialogExecution object ● WorkflowExecution object ● WorkflowPage object ● WorkflowVariant object