workflowDraft
The workflowDraft is a GraphQL API schema that retrieves detailed information of a specified draft version of a workflow.
Argument | Description |
draftId | The unique identifier for the workflow draft that is being accessed. |
tenant | The tenant string specifies the client's information for identification purposes. |
The workflowDraft returns a data object with the following fields:
Field | Description |
canMerge | Indicates if the workflow draft can be merged with others. |
createdAt | Timestamp of when the workflow draft was created. |
createdBy | User who created the workflow draft. |
description | Descriptive text providing more details about the workflow draft. |
expire | The date/time when the workflow draft is set to expire. |
id | Unique identifier for the workflow draft. |
meta | Contains additional metadata associated with the workflow draft. |
name | The name of the workflow draft. |
tenantId | Identifier for the tenant that the workflow draft belongs to. |
updatedAt | Timestamp of when the workflow draft was last updated. |
updatedBy | User who last updated the workflow draft. |
Here is a sample GraphQL query using the workflowDraft schema:
In this query, we are requesting detailed information for the workflow draft with the draftId "draft123" for the exampleTenant tenant.
A successful response may look something like the following:
The response indicates that the workflow draft is mergeable, provides its creation and update timestamps, shows who created and last updated the draft, and includes other details like its description, expiry date, and associated metadata.