Content Comparison

x-everit-jwt

false

JWT token, see: REST API

x-requested-by

false

CSRF protection parameter. Can be empty or any dummy text.

x-timezone

true

The time zone of the user, for eg.: Europe/Budapest. If not specified defaults to UTC.

startAt

number

false

The index of the first item returned in the page of results.

Example: “startAt”: 0

startDate

string
(format: "yyy-MM-dd")

false

The start date from which the worklogs can be viewed. The query is run from the beginning of the given day (00:00:00)
Example: “startDate”: “2021-01-01”

endDate

string
(format: "yyy-MM-dd")

false

The end date until which the worklogs can be viewed. The query is run until the end of the given day (23:59:59).

Example: “endDate”: “2023-01-01”

filterBillable

boolean

true

Filtering worklogs based on this boolean. True returns billable worklogs, false returns non-billable worklogs.

If this parameter is not provided both billable and non-billable worklogs are returned.

Example: “filterBillable”: true

projects

string[]

true

IDs of projects whose worklogs will be returned.

If this parameter is not provided the worklogs will not be filtered based on projects.

Example: “projects”: [“10000“]

filters

string[]

true

IDs of filters whose worklogs will be returned.

If this parameter is not provided the worklogs will not be filtered based on filter ids.

Example: “filters”: [“10020“]

jql

string

true

JQL expression to filter the issues whose worklogs will be returned.

If this parameter is not provided the worklogs will not be filtered based on this parameter.

Example: “jql”: “project = S1“

groups

string[]

true

Names of groups whose worklogs will be returned.

If this parameter is not provided the worklogs will not be filtered based on user groups.

Example: “groups”: [“administrators“]

users

string[]

true

AccountIds of users whose worklogs will be returned.

If this parameter is not provided the worklogs will not be filtered based on worklog authors.

Example: “users”: [“5f18aff107efc400285dfe12“]

expand

string[]

true

Use expand to include additional information about issues and worklogs in the response.

If this parameter is not provided the result will not be expanded.

Possible values: ASSIGNEE, AUTHOR, PRIORITY, PROJECT, REPORTER, STATUS, TYPE

Example: “expand”: [“PROJECT“, “AUTHOR“]

maxResults

number

true

The maximum number of items that can be returned per page. Defaults to 50.
Example: “maxResults” : 1000

groupBy

string

true

How the result will be grouped. Defaults to: “projectView“. In the response object only the corresponding array will be filled.

Possible values: "affectedVersionsView", "componentView", "fixedVersionsView", "issueView", "projectView", "userView", “billableView”, “tagView”

Example: “groupBy” : “affectedVersionsView“

reportTagFilter

ReportTagFilter

true

Report tag filter data. A worklog is returned if it has at least one of the tag specified in the tags array.

If this parameter is not provided the result will not be filtered based on tags.

Example:

    "reportTagFilter": {
        "includeTaglessWorklogs": true,
        "tags": [1, 5]
    }

includeTaglessWorklogs

boolean

true

Include tagless worklogs or not.

If not provided defaults to false.

Example: “includeTaglessWorklogs”: true

tags

number[]

true

Tag ids whose worklogs will be returned.

If not provided defaults to empty array.

Example: “tags”: [ 1, 5 ]