Schema definition for Workflow Summary Page.
What this schema does
Defines the object fields used for workflow summary page data exchanged by this API.
Used in endpoints
This schema is used as a response structure in the following endpoints:
GET /v1/workflows(response code(s): 200)
Fields
| Field | Type | Required | Description |
|---|---|---|---|
| items | array<object> | Yes | List of items returned for the current page of results. |
| totalPages | integer | Yes | Total number of pages available for the current query. |
| totalItems | integer | Yes | Total number of items available across all pages. |
| currentPage | integer | Yes | Number of the current page returned in the response. |
| pageSize | integer | Yes | Maximum number of items returned per page. |
{
"items": [
{
"definitionId": "string",
"workspaceId": "string",
"name": "string",
"description": "string",
"state": "string",
"triggerType": "string",
"version": 0,
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string"
}
],
"totalPages": 0,
"totalItems": 0,
"currentPage": 0,
"pageSize": 0
}