Skip to content
This repository was archived by the owner on May 28, 2024. It is now read-only.
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 61 additions & 2 deletions src/main/resources/openapi/specs/api.kuflow.com/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -95,13 +95,17 @@ paths:
/processes:
get:
summary: Find all accessible Processes
description: List all the Processes that have been created and the the credentials has access.
description: |
List all the Processes that have been created and the the credentials has access.

Available sort query values: id, createAt, lastModifiedAt
operationId: findProcesses
tags:
- process
parameters:
- $ref: "#/components/parameters/SizeQueryParam"
- $ref: "#/components/parameters/PageQueryParam"
- $ref: "#/components/parameters/SortQueryParam"
responses:
"200":
description: Processes found paginated
Expand Down Expand Up @@ -331,13 +335,17 @@ paths:
/tasks:
get:
summary: Find all accessible Taks
description: List all Tasks that have been created and the the credentials has access.
description: |
List all Tasks that have been created and the the credentials has access.

Available sort query values: id, createdAt, lastModifiedAt, claimedAt, completedAt, cancelledAt
operationId: findTasks
tags:
- task
parameters:
- $ref: "#/components/parameters/SizeQueryParam"
- $ref: "#/components/parameters/PageQueryParam"
- $ref: "#/components/parameters/SortQueryParam"
- name: processId
in: query
schema:
Expand All @@ -351,6 +359,12 @@ paths:
type: array
items:
$ref: "#/components/schemas/TaskState"
- name: taskDefinitionCode
in: query
schema:
type: array
items:
type: string

responses:
"200":
Expand Down Expand Up @@ -635,6 +649,38 @@ paths:
type: string
format: binary

/tasks/{id}/~actions/download-element-value-form-rendered:
get:
summary: Download a Form rendered as PDF or Zip of PDFs (when the element is multiple)
description: |
Given a task, generate a PDF from a Form type element with the data filled in, if any.
If there are multiple form values, they are packed into a ZIP.

Important!: To use this feature, please contact to kuflow@kuflow.com
operationId: actionsDownloadTaskElementValueRendered
tags:
- task
parameters:
- $ref: "#/components/parameters/IdPathParam"
- name: code
in: query
description: Element code of a Form Element to download.
required: true
schema:
type: string
responses:
"200":
description: Form requested as PDF or ZIP of PDFs.
content:
"application/pdf":
schema:
type: string
format: binary
"application/zip":
schema:
type: string
format: binary

/tasks/{id}/~actions/complete:
post:
summary: Complete a task
Expand Down Expand Up @@ -722,6 +768,19 @@ components:
type: integer
default: 0
minimum: 0
SortQueryParam:
name: sort
in: query
description: |
Sorting criteria in the format: property{,asc|desc}. Example: createdAt,desc

Default sort order is ascending. Multiple sort criteria are supported
Please refer to the method description for supported properties.
required: false
schema:
type: array
items:
type: string

schemas:
DefaultError:
Expand Down