GET/workload.json

Get Workload

List the workload across all projects, sort by Users, Company or Project.

Query Params

  • Name
    startDate
    Type
    string
    required
    Description

    Start date in the format of yyyymmdd

  • Name
    endDate
    Type
    string
    required
    Description

    End date in the format of yyyymmdd

  • Name
    includeTasksWithoutDates
    Type
    boolean
    Description

    Include tasks without Due dates

    Default
    false
  • Name
    distributeEstimatedTimeToAssignees
    Type
    boolean
    Description
    Default
    false
  • Name
    prorataEstimatedTime
    Type
    string
    Description
  • Name
    page
    Type
    integer
    Description

    The Page number to view

  • Name
    pageSize
    Type
    integer
    Description

    The number of results per page

  • Name
    sortBy
    Type
    string
    Description

    Sort by 'users', 'company' or 'project'

    Allowed values
    • users
    • company
    • project
  • Name
    tagIds
    Type
    integer
    Description
  • Name
    matchAllTags
    Type
    boolean
    Description
    Default
    false
  • Name
    excludeTagIds
    Type
    integer
    Description
  • Name
    matchAllExcludedTags
    Type
    boolean
    Description
    Default
    false
  • Name
    onlyUntaggedTasks
    Type
    boolean
    Description
    Default
    false
  • Name
    includeCapacity
    Type
    boolean
    Description

    When sorting by user, returns a new capacity field for each user that represents the percentage of workload compared to the available time

    Default
    false
  • Name
    showOnlyUsersWithRemainingCapacity
    Type
    boolean
    Description

    Only return users where capacity is bellow 100%, so we can detect the users that can take more tasks

    Default
    false
  • Name
    includeAllUsers
    Type
    boolean
    Description

    Side load all other users that we can assign a task in the installation

    Default
    false
  • Name
    userIdsToInclude
    Type
    string
    Description

    Always include this users capacity, even if not matching the current filter

    Default
    list of numeric numbers
  • Name
    userCompanyIds
    Type
    string
    Description

    Filter by users' company IDs

    Default
    List of numeric numbers
  • Name
    userSortBy
    Type
    string
    Description

    After sorting by user, this allows to sort the users by sub-categories

    Default
    name
    Allowed values
    • name
    • company
    • capacity
  • Name
    searchUserName
    Type
    string
    Description

    Filter by the user names

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 Response

Examples

200 Response

application/json
{
  "workload": [
    {
      "numberOfUsers": "1",
      "totalLoggedTime": "0",
      "totalMarkedComplete": "6900",
      "companyName": "Acme Company",
      "userCompanyId": "",
      "userLastName": "",
      "projectName": "",
      "numberOfProjects": "1",
      "projectId": "",
      "userCompanyName": "",
      "percentageLoggedTime": "0",
      "totalStillActive": "95",
      "numberOfCompletedTasks": "90",
      "avatar-url": "",
      "userFirstName": "",
      "percentageStillActive": "1",
      "numberOfActiveTasks": "1",
      "totalEstimatedTime": "6995",
      "percentageMarkedComplete": "99",
      "numberOfTasks": "96",
      "companyId": "12345",
      "userId": ""
    }
  ],
  "STATUS": "OK"
}
Download Swagger