Workflow Object

Root Connection

All Workflow objects of an account are accessible by a query on the root connection changes. Such a query will return a WorkflowConnection!, which contains the Workflow objects in its nodes field.

changes (WorkflowConnection!)

Root connection for retrieving Workflow records.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

filter WorkflowFilter

Filter to determine which Workflow records are returned.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

order [WorkflowOrder!]

Order of the Workflow records returned.

view WorkflowView

View name.

The default value is current_account.

Root Connection

All Workflow objects of an account are accessible by a query on the root connection workflows. Such a query will return a WorkflowConnection!, which contains the Workflow objects in its nodes field.

workflows (WorkflowConnection!)

Root connection for retrieving Workflow records.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

filter WorkflowFilter

Filter to determine which Workflow records are returned.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

order [WorkflowOrder!]

Order of the Workflow records returned.

view WorkflowView

View name.

The default value is current_account.

Fields

The fields in this section list which values can be retrieved when querying Workflow records.

account (Account)

The account this record belongs to.

actualEffort (Int)

The total time that has already been spent on the workflow. This is the sum of the time spent on each of the workflow's tasks and the requests and problems that are related to the workflow.

actualVsPlannedEffortPercentage (Int)

The actual effort as a percentage of the planned effort.

category (WorkflowCategory)

The category of the workflow.

changeId (String)

Deprecated: This field has been renamed. Use workflowId instead.

The record ID as displayed in the UI

changeType (String)

Deprecated: This field has been renamed. Use workflowType instead.

Used to indicate whether the workflow needs to be implemented following the procedure steps for application changes or for infrastructure changes.

completedAt (ISO8601Timestamp)

The date and time at which the workflow is saved with the status "Completed".

completionReason (WorkflowCompletionReason)

Used to select the appropriate completion reason for the workflow when it has been completed. It is automatically set to "Complete" when all tasks related to the workflow have reached the status "Completed", "Approved" or "Canceled".

completionTargetAt (ISO8601Timestamp)

Shows the target date and time of the last task of the workflow.

createdAt (ISO8601Timestamp)

The date and time at which the record was created.

customFields ([CustomField!])

Values of custom fields.

id (ID!)

Unique identifier of the object.

impact (TaskImpact)

The maximum impact level that is selected in the tasks that are a part of the workflow. This indicates the maximum extent to which the service is impacted when the implementation tasks that are related to the workflow are executed.

justification (WorkflowJustification)

The reason why the workflow was requested.

lifeCycleState (LifeCycleState)

Current state of the record.

manager (Person)

Who is responsible for coordinating the implementation of the workflow. If a manager is not specified for a new workflow, the API user is selected in the Manager field by default.

plannedEffort (Int)

The total planned effort of the workflow. This is the sum of the planned effort (or planned duration if the planned effort is empty) of the workflow's tasks.

project (Project)

Linked project

release (Release)

The release that the workflow is a part of.

resolutionDuration (Int)

The number of minutes it took to complete this workflow, which is calculated as the difference between the createdAt and completedAt values.

service (Service)

The service that will directly be affected by the workflow implementation, or in case of an emergency change, the service that was directly affected by the workflow implementation.

source (String)

An identifier for the client application submitting the resource or the name of an external system

sourceID (String)

The unique identifier of the resource in an external system

startAt (ISO8601Timestamp)

The date and time at which the Status field of the first tasks of the workflow will automatically be set to "Assigned".

status (WorkflowStatus)

Automatically set based on the status of the workflow's tasks.

subject (String)

A short description of the objective of the workflow.

template (WorkflowTemplate)

The workflow template that was used to register the workflow.

updatedAt (ISO8601Timestamp)

The date and time of the last update of the record. If the record has no updates it contains the createdAt value.

workflowId (String)

The record ID as displayed in the UI

workflowType (String)

Used to indicate the type of the workflow.

Connections

The connection fields in this section allow (paged) access to objects related to a specific Workflow record. The actual objects will be in the nodes field of the connection.

automationRules (AutomationRuleConnection)

Automation rules associated with this record.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

customFieldsAttachments (AttachmentConnection)

Inline images linked to one of the custom fields.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

invoices (InvoiceConnection)

Invoices associated with this object.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

notes (NoteConnection)

Notes of the record.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

phases (WorkflowPhaseConnection)

Phases of the workflow.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

problems (ProblemConnection)

All problems of this workflow.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

requests (RequestConnection)

All requests of this workflow.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

tasks (TaskConnection)

All tasks of this workflow.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

Implements

Workflow implements the following interfaces. This means that fragments defined on these interfaces may be used in queries returning a Workflow.