Generate tasklist report in XLSX format
Generates a task list report in XLSX format containing all tasks for the provided filters. Only the tasks that the logged-in user can access will be returned.
Path Params
- Name
projectId
- Type
- integer
- required
- Description
Query Params
- Name
taskDate
- Type
- string
- Description
filter by task date
- Default
anytime
- Allowed values
all
anytime
completed
created
overdue
today
yesterday
started
tomorrow
thisweek
within7
within14
within30
within365
nodate
noduedate
nostartdate
newTaskDefaults
hasDate
- Name
startDate
- Type
- string
- Description
filter by start datetime
- Name
reportFormat
- Type
- string
- Description
define the format of the report
- Name
orderMode
- Type
- string
- Description
order mode
- Default
asc
- Allowed values
asc
desc
- Name
orderBy
- Type
- string
- Description
order by
- Default
manual
- Allowed values
startdate
createdat
priority
project
flattenedtasklist
company
manual
active
completedatdesc
completedat
duestartdate
duestartdatedesc
alldates
alldatesdesc
duedateDESC
tasklistname
tasklistdisplayorder
tasklistid
duedate
updatedat
taskname
- Name
endDate
- Type
- string
- Description
filter by end datetime
- Name
commentsOrderMode
- Type
- string
- Description
order mode of the comments
- Default
asc
- Allowed values
asc
desc
- Name
tasklistId
- Type
- integer
- Description
filter by task list
- Name
projectId
- Type
- integer
- Description
filter by project
- Name
useFormulaFields
- Type
- boolean
- Description
use formula fields
- Name
onlyCompletedTasks
- Type
- boolean
- Description
only completed tasks
- Default
false
- Name
isReportDownload
- Type
- boolean
- Description
generate a report document
- Name
includeTime
- Type
- boolean
- Description
include time
- Name
includeTags
- Type
- boolean
- Description
include tags
- Default
true
- Name
includeStages
- Type
- boolean
- Description
include stages
- Default
true
- Name
includePrivateItems
- Type
- boolean
- Description
include private items
- Default
true
- Name
includeLateTasks
- Type
- boolean
- Description
include late tasks
- Name
includeEstimatedTime
- Type
- boolean
- Description
include estimated time
- Default
true
- Name
includeCustomFields
- Type
- boolean
- Description
include custom fields
- Default
false
- Name
includeCompletedTasks
- Type
- boolean
- Description
include completed tasks
- Default
true
- Name
includeComments
- Type
- boolean
- Description
include comments
- Default
false
- Name
includeCommentAvatars
- Type
- boolean
- Description
include comment avatars
- Name
includeColumns
- Type
- boolean
- Description
include columns
- Default
true
- Name
includeAnytimeTasks
- Type
- boolean
- Description
include anytime tasks
- Name
includeAllComments
- Type
- boolean
- Description
include all comments
- Default
false
- Name
ignoreStartDates
- Type
- boolean
- Description
ignore task start dates
- Name
groupByTasklists
- Type
- boolean
- Description
group by task lists
- Name
tags
- Type
- array[string]
- Description
filter by tag names
- Format
- Comma separated values
- Name
tagIds
- Type
- array[integer]
- Description
filter by tag ids
- Format
- Comma separated values
- Name
assignedToUserIds
- Type
- array[integer]
- Description
filter by assigned user ids
- Format
- Comma separated values
- Name
assignedToTeamIds
- Type
- array[integer]
- Description
filter by assigned team ids
- Format
- Comma separated values
- Name
assignedToCompanyIds
- Type
- array[integer]
- Description
filter by assigned company ids
- Format
- Comma separated values
Responses
- Code
- 200
- Description
- 200 OK No Data
- Code
- 400
- Type
- object
- Schema
- Description
- 400 Bad Request
ErrorResponse defines how []Error should be marshaled to JSON.
- Code
- 403
- Type
- object
- Schema
- Description
- 403 Forbidden
ErrorResponse defines how []Error should be marshaled to JSON.
400 Bad Request
{
"errors": [
{
"code": "string",
"detail": "string",
"id": "string",
"meta": {},
"title": "string"
}
]
}