workflow
The workflow is a GraphQL API schema that retrieves a specific version of a workflow, including its detailed information, conditions, input requirements, and associated metadata.
Argument | Description |
tenant | The tenant string specifies the client's information for identification purposes. |
workflowId | The unique identifier for the workflow that is being accessed. |
version | The specific version of the workflow to retrieve. |
The workflow returns a data object with the following fields:
Field | Description |
canMerge | Indicates if the workflow can be merged with others. |
conditions | Specifies the conditions for the workflow's execution. |
createdAt | Timestamp of when the workflow was created. |
createdBy | User who created the workflow. |
description | Descriptive text providing more details about the workflow. |
flows | Contains the sequence of steps and paths in the workflow. |
id | Unique identifier for the workflow. |
inputs | Defines the input parameters required by the workflow. |
jsonSchema | The JSON schema representing the structure of the workflow. |
meta | Contains additional metadata associated with the workflow. |
name | The name of the workflow. |
status | The current status of the workflow. |
tenantId | Identifier for the tenant that the workflow belongs to. |
updatedAt | Timestamp of when the workflow was last updated. |
updatedBy | User who last updated the workflow. |
version | The version of the workflow. |
- tag: A nested object that contains the name and value fields for tagging and categorizing the workflow.
Field | Description |
name | The name of the tag. |
value | The value associated with the tag name. |