Schema definition for workflow summary.
What this schema does
Defines the object fields used for workflow summary data exchanged by this API.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
| definitionId | string | Yes | Unique identifier for the workflow definition. |
| workspaceId | string | Yes | Unique identifier for the workspace that owns the workflow. |
| name | string | Yes | Name of the workflow. |
| description | string | No | Optional description that provides additional details about the workflow. |
| state | string | Yes | Current state of the workflow (for example, Enabled, Disabled, or Archived). |
| triggerType | string | Yes | Type of trigger that starts the workflow. |
| version | integer | Yes | Version number of the workflow definition. |
| createdAt | string (date-time) | Yes | Date and time when the workflow was created. |
| createdBy | string | Yes | Identifier of the user or service that created the workflow. |
| updatedAt | string (date-time) | Yes | Date and time when the workflow was last updated. |
| updatedBy | string | Yes | Identifier of the user or service that last updated the workflow. |
{
"definitionId": "string",
"workspaceId": "string",
"name": "string",
"description": "string",
"state": "string",
"triggerType": "string",
"version": 0,
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string"
}