workflow Query
Returns the specified Workflow object.
Access is permitted when any of the following condition(s) are met: 1. The signed-in User has any of the following permissions for the associated Organization: [org_admin_integration_permissions, org_manage_integrations, org_view_integrations]. 2. The signed-in User has any of the following permissions for any version of the object: [integration_admin_permissions, integration_view, integration_edit, integration_remove]. 3. The signed-in User has any of the following permissions for the associated Customer of Integrations available in the Marketplace: [customer_admin_instance_deploy, customer_manage_marketplace_integrations]. 4. The signed-in User has any of the following permissions for the associated Customer of Integrations available in the Marketplace: [customer_access_marketplace_integrations]. 5. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_admin_integration_permissions, customer_manage_integrations, customer_view_integrations]. 6. The Customer User has any of the following permissions for the Customer and the Objects Attribute template_configuration is AVAILABLE: [customer_admin_integration_permissions, customer_manage_integrations, customer_view_integrations].
Input fields
| Argument | Type | Description |
|---|---|---|
id | ID! | The ID of the Workflow object. |
Return fields (Workflow)
actions (WorkflowActionConnection!)
The individual actions within this Workflow.
allowRemove (Boolean!)
Specifies whether the signed-in User can remove the Workflow.
allowUpdate (Boolean!)
Specifies whether the signed-in User can update the Workflow.
components (ComponentConnection!)
Components associated with this Workflow.
createdAt (DateTime!)
The timestamp at which the object was created.
customer (Customer)
The Customer that this Workflow belongs to.
customerConfigVariables (CustomerConfigVariableConnection!)
Returns a list of Customer Config Variables associated with this Workflow.
definition (String)
The YAML that is the declarative definition for the Integration that backs this Workflow.
deployedVersion (Workflow)
The deployed version of this Workflow.
description (String)
Additional notes about the Workflow.
documentation (String)
Rich text documentation to accompany the Workflow.
enablementBlockers ([EnablementBlocker]!)
List of reasons preventing this Workflow from being enabled.
flow (WorkflowFlow!)
The singular Flow that represents the Workflow.
hasUnpublishedChanges (Boolean!)
Specifies whether the Workflow definition has changes that have not yet been published.
id (ID!)
The ID of the object
instance (Instance)
The singular Instance that runs this Workflow.
lastExecutedAt (DateTime)
The timestamp at which this Workflow was most recently executed.
metadata (JSONString)
A JSON string that represents metadata about the Workflow.
name (String!)
The name of the Workflow.
scopedConfigVariables (ScopedConfigVariableConnection!)
Returns a list of Scoped Config Variables associated with this Workflow.
starred (Boolean)
Indicates whether the record is starred by the signed-in User.
systemInstance (Instance!)
System Instance backing this Workflow.
template (WorkflowTemplate)
The WorkflowTemplate associated with this Workflow, if any.
testCases (TestCaseConnection!)
Test cases associated with this Workflow, if any.
updatedAt (DateTime!)
The timestamp at which the object was most recently updated.
validationRules (IntegrationValidationRules!)
Validation Rules applied to this Workflow.
versionAt (Workflow)
Object data at specified version
versionAttributes (JSONString)
Additional attributes that are specific to this version.
versionComment (String)
Additional comments about this version.
versionCreatedAt (DateTime)
Timestamp of the creation of this version.
versionCreatedBy (User)
User that created this version.
versionIsAvailable (Boolean!)
Indicates if the version is available for use.
versionIsLatest (Boolean!)
Marked if this record is the latest version of this sequence.
versionNumber (Int!)
Sequential number identifying this version.
versionSequence (WorkflowConnection)
Sequence of versions of this Workflow.
versionSequenceId (UUID)
Identifier for this version sequence.