GET/projects/api/v3/reporting/precanned/plannedvsactual/milestones.pdf

Generate 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.

Query Params

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

Examples

400 Bad Request

ErrorResponse
{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "id": "string",
      "meta": {},
      "title": "string"
    }
  ]
}