The worklog query can be accessed from the link below: JIRA-URL/rest/jttp-rest/REST-API-VERSION/worklog-query/worklogQuery
REST-API-VERSION after version 4.2.0 is "4" or "latest" |
The query returns the worklogs that belong to the specified interval. The query considers the start date value of the worklog.
The GET parameter of the worklogs query is a JSON: "filterConditionJson" and an optional "customFieldsFilter".
The available keys of the parameter filterConditionJson:
parameter | value | optional | description |
---|---|---|---|
groupUsers | string list | true | The JIRA group or list of user names whose worklogs are to be listed. The default value is all users.
The "groupUsers" parameter requires userKey value |
issueAffectedVersions | string list | true | The affected version of a JIRA issue. |
issueAssignees | string list | true | The assignee of a JIRA issue, specifying with the assignee's user key. |
issueComponents | string list | true | The related component name of a JIRA issue. |
issueFixedVersions | string list | true | The fix version of a JIRA issue. |
issueKeys | string list | true | The key parameter of a JIRA issue. Unless it is defined, all issues are queried. |
issueStatusNames | string list | true | The status name of a JIRA issue. |
issueTypeNames | string list | true | The type name of a JIRA issue. |
limit | long | true | The number of results returned. |
offset | long | true | The first entry to return from the results. |
projectKeys | string list | true | The key parameter of a JIRA project. Unless it is defined, all projects are queried. |
worklogEndDate | "YYYY-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). |
worklogStartDate | "YYYY-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) |
Components are sub-sections of a project.
The customFieldsFilter is a JSON array containing the custom field ids of the custom fields you would like to be returned in the response.
query parameter | value | optional | description |
---|---|---|---|
customFieldsFilter | number list | true | The id-s of the customfields you would like to be returned in the response. |