Back to TeamworkGenerate milestone report in PDF format
Generates a milestone report in PDF format containing all milestones for the
provided filters. Only the milestones that the logged-in user can access will
be returned.
Input
type: object
properties:
parameters:
type: object
properties:
updatedAfterDate:
type: string
format: date-time
description: filter by updated after date (deprecated, use updatedAfter)
updatedAfter:
type: string
format: date-time
description: filter by updated after date
searchTerm:
type: string
description: filter by milestone name and description
reportType:
type: string
enum:
- plannedvsactual
- calendar
- agenda
default: agenda
description: define the type of the report
reportFormat:
type: string
description: define the format of the report
projectStatus:
type: string
description: filter by project status
orderMode:
type: string
enum:
- asc
- desc
default: asc
description: order mode
orderBy:
type: string
enum:
- date
- dateonly
- name
- project
- user
- dateCreated
- dateUpdated
default: date
description: order by
dueBeforeDate:
type: string
format: date
description: filter by due before date (deprecated, use dueBefore)
dueBefore:
type: string
format: date
description: filter by due before date
dueAfterDate:
type: string
format: date
description: filter by due after date (deprecated, use dueAfter)
dueAfter:
type: string
format: date
description: filter by due after date
pageSize:
type: integer
default: '50'
description: number of items in a page
page:
type: integer
default: '1'
description: page number
showPrivate:
type: boolean
default: 'true'
description: show private milestones
showDeleted:
type: boolean
default: 'false'
description: include deleted items
showAttachedTasklists:
type: boolean
description: show attached tasklists
searchCompaniesTeams:
type: boolean
description: include companies and teams in the search term
searchAssignees:
type: boolean
description: include assignees in the search
progress:
type: boolean
default: 'false'
description: >-
include percentage of tasks completed for all linked tasklists
(deprecated, use includePercentageComplete)
onlyStarredProjects:
type: boolean
description: filter by starred projects only
onlyMyProjects:
type: boolean
default: 'false'
description: filter by projects that the logged-in user is related
onlyAdminProjects:
type: boolean
description: >-
only include milestones from projects where the user is strictly a
project admin.
site admins have visibility to all projects.
matchAllTags:
type: boolean
description: match all milestone tags
matchAllProjectTags:
type: boolean
description: match all project tags
isReportDownload:
type: boolean
description: generate a report document
includeUpdate:
type: boolean
description: include milestones latest update action
includeToday:
type: boolean
default: 'true'
description: include today when milestone status is upcoming
includeTeamUserIds:
type: boolean
default: 'true'
description: include team users to the responsible party ids
includeTags:
type: boolean
default: 'true'
description: include tags in the reports
includeProgress:
type: boolean
default: 'false'
description: >-
include percentage of tasks completed for all linked tasklists
(deprecated, use includePercentageComplete)
includePercentageComplete:
type: boolean
default: 'false'
description: include percentage of tasks completed for all linked tasklists
includeCompleted:
type: boolean
description: optional to include completed milestones
includeCompanyUserIds:
type: boolean
default: 'true'
description: include company users to the responsible party ids
includeAssigneeTeams:
type: boolean
description: include teams related to the responsible user ids
includeAssigneeCompanies:
type: boolean
description: include companies related to the responsible user ids
includeArchivedProjects:
type: boolean
default: 'false'
description: include archived projects
emoji:
type: boolean
default: 'true'
description: convert emoji alias to unicode
countUnreadComments:
type: boolean
default: 'false'
description: count unread comments
calendar:
type: boolean
default: 'false'
description: enables the calendar style layout
tagIds:
type: array
items:
type: integer
description: filter by milestone tag ids
status:
type: array
items:
enum:
- all
- new
- reopened
- completed
- deleted
- pending
- incomplete
- late
- today
- upcoming
type: string
description: filter by list of milestone status
selectedColumns:
type: array
items:
type: string
description: customise the report by selecting columns to be displayed.
projectTagIds:
type: array
items:
type: integer
description: filter by project tag ids
projectStatuses:
type: array
items:
type: string
description: filter by list of project status
projectOwnerIds:
type: array
items:
type: integer
description: filter by project owner ids
projectIds:
type: array
items:
type: integer
description: filter by project ids
projectHealths:
type: array
items:
type: integer
description: filter by list of project health
projectHealth:
type: array
items:
type: integer
description: filter by list of project health (deprecated, use projectHealths)
projectCompanyIds:
type: array
items:
type: integer
description: filter by company ids
projectCategoryIds:
type: array
items:
type: integer
description: filter by project category ids
include:
type: array
items:
enum:
- projects
- projects.companies
- projects.categories
- users
- completedBy
- createdBy
- deletedBy
- updatedBy
- commentFollowers
- changeFollowers
- tags
- tasklists
- tasklisttaskstats
type: string
description: include
ids:
type: array
items:
type: integer
description: filter by ids
followerIds:
type: array
items:
type: integer
description: filter by followers' ids
fields[users]:
type: array
items:
enum:
- id
- firstName
- lastName
- title
- email
- companyId
- company
- isAdmin
- isClientUser
- isServiceAccount
- type
- deleted
- avatarUrl
- lengthOfDay
- workingHoursId
- workingHour
- userRate
- userCost
- canAddProjects
type: string
fields[tasklists]:
type: array
items:
enum:
- id
- name
- projectId
- milestoneId
type: string
fields[tags]:
type: array
items:
enum:
- id
- name
- color
- count
type: string
fields[projects]:
type: array
items:
enum:
- id
- name
type: string
fields[milestones]:
type: array
items:
enum:
- id
- name
- description
- deadline
- completed
- projectId
- createdOn
- lastChangedOn
- creatorUserId
- reminder
- private
- lockdownId
- status
- completedOn
- completerId
- percentageComplete
type: string
fields[companies]:
type: array
items:
enum:
- id
- name
- logoUploadedToServer
- logoImage
type: string
creatorIds:
type: array
items:
type: integer
description: filter by creators' 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
title: Parameters