Document toolboxDocument toolbox

Response

In the case of a successful query the worklog information is returned (with HTTP 200 OK status) in JSON format, as:

[ { "customFields":{...}, "details":{...} }, ... ]

The customFields item consist data based on the customFieldsFilter. If customFieldsFilter query parameter not provided all custom fields will be returned, else only the custom fields will be returned that ids are inside of the customFieldsFilter array. Example:

keyvaluedescription
Epic Colourstring
Epic Statusstring
Rankstring
Sprintstring
Epic NamestringThe epic name of the issue to which the worklog belongs.
Epic LinkstringThe epic link of the issue to which the worklog belongs.
Story Points

The details item consist of the following data:

keyvaluedescription
issueAffectedVersionsstring listList of affected versions of the issue to which the worklog belongs.
issueAssigneestringAssignee of the issue to which the worklog belongs.
issueComponentsstring listList of components of the issue to which the worklog belongs.
issueCreatedtimestampCreated date of the issue to which the worklog belongs.
issueFixedVersionsstring listList of fixed versions of the issue to which the worklog belongs.
issueKeystringKey value of the issue to which the worklog belongs.
issueOriginalEstimatelongOriginal estimate time of the issue to which the worklog belongs in seconds.
issueRemainingEstimatelongRemaining estimate time of the issue to which the worklog belongs in seconds
issueReporterstringReporter of the issue to which the worklog belongs.
issueStatusNamestringStatus name of the issue to which the worklog belongs.
issueSummarystringThe summary of the issue to which the worklog belongs.
issueTypeNamestringType name of the issue to which the worklog belongs.
issueUpdatedtimestampUpdated date of the issue to which the worklog belongs.
labelsstring listList of labels.
parentIssueKeystringThe key of the parent issue of the issue to which the worklog belongs.
priorityNamestringName of the priority of the issue to which the worklog belongs.
projectDescriptionstringDescription of the project to whose issue the worklog belongs.
projectNamestringName of the project to whose issue the worklog belongs.
resolutionNamestringThe resolution name of the issue to which the worklog belongs.
subTasksstring listList of subtasks.
worklogBodystringBody of the worklog (worklog description).
worklogCreatedtimestampCreated date of the worklog.
worklogStartDatetimestampStart date of the worklog.
worklogTimeWorkedlongDuration of the worklog in seconds.
worklogUpdatedtimestampUpdated date of the worklog.
worklogUserstringID of the JIRA user who created the worklog.
worklogAttributesstring listList of the worklog attributes
costdoubleThe cost of the worklog. Project Controller permission required to view this attribute.
costRateTypestring

The type of the current cost element/attribute. Project Controller permission required to view this attribute.

  • USER_SPECIFIC
  • DEFAULT
  • ZERO
currencystringThe configured currency. Project Controller permission required to view this attribute.