Teamwork API
Getting access, Developing, Testing
Back to TeamworkGenerate tasklist report in PDF format
Generates a task list report in PDF format containing all tasks for the
provided filters. Only the tasks that the logged-in user can access will be
returned.
Input
type: object
properties:
parameters:
type: object
properties:
taskDate:
type: string
enum:
- all
- anytime
- completed
- created
- overdue
- today
- yesterday
- started
- tomorrow
- thisweek
- within7
- within14
- within30
- within365
- nodate
- noduedate
- nostartdate
- newTaskDefaults
- hasDate
default: anytime
description: filter by task date
startDate:
type: string
format: date-time
description: filter by start datetime
reportFormat:
type: string
description: define the format of the report
orderMode:
type: string
enum:
- asc
- desc
default: asc
description: order mode
orderBy:
type: string
enum:
- startdate
- createdat
- priority
- project
- flattenedtasklist
- company
- manual
- active
- completedatdesc
- completedat
- duestartdate
- duestartdatedesc
- alldates
- alldatesdesc
- duedateDESC
- tasklistname
- tasklistdisplayorder
- tasklistid
- duedate
- updatedat
- taskname
default: manual
description: order by
endDate:
type: string
format: date-time
description: filter by end datetime
commentsOrderMode:
type: string
enum:
- asc
- desc
default: asc
description: order mode of the comments
tasklistId:
type: integer
description: filter by task list
projectId:
type: integer
description: filter by project
onlyCompletedTasks:
type: boolean
default: 'false'
description: only completed tasks
isReportDownload:
type: boolean
description: generate a report document
includeTime:
type: boolean
description: include time
includeTags:
type: boolean
default: 'true'
description: include tags
includePrivateItems:
type: boolean
default: 'true'
description: include private items
includeLateTasks:
type: boolean
description: include late tasks
includeEstimatedTime:
type: boolean
default: 'true'
description: include estimated time
includeCustomFields:
type: boolean
default: 'false'
description: include custom fields
includeCompletedTasks:
type: boolean
default: 'true'
description: include completed tasks
includeComments:
type: boolean
default: 'false'
description: include comments
includeCommentAvatars:
type: boolean
description: include comment avatars
includeColumns:
type: boolean
default: 'true'
description: include columns
includeAnytimeTasks:
type: boolean
description: include anytime tasks
includeAllComments:
type: boolean
default: 'false'
description: include all comments
ignoreStartDates:
type: boolean
description: ignore task start dates
groupByTasklists:
type: boolean
description: group by task lists
tags:
type: array
items:
type: string
description: filter by tag names
tagIds:
type: array
items:
type: integer
description: filter by tag ids
assignedToUserIds:
type: array
items:
type: integer
description: filter by assigned user ids
assignedToTeamIds:
type: array
items:
type: integer
description: filter by assigned team ids
assignedToCompanyIds:
type: array
items:
type: integer
description: filter by assigned company ids
required:
- projectId
title: Parameters