Download OpenAPI specification:
API for time tracking features (worklogs, statuses, metadata lookups and reporting).
Retrieves a list of Jira components filtered by jira_component and/or jira_project. Used for mapping worklogs to specific Jira components.
| jira_component | string |
| jira_project | string |
| debug | string |
[- {
- "jira_project": "string",
- "jira_component": "string"
}
]Retrieves all available attribute types. Attribute types define the metadata fields that can be attached to a worklog (e.g., Billable, Location).
| debug | string |
[- {
- "attributeTypeId": 0,
- "attributeType": "string",
- "description": "string"
}
]Retrieves GPS clocking data for a specific author within a given period. Used to compare registered work hours with actual clock-in/out times.
| author required | string |
required | object (PeriodDto) |
[- {
- "day": "2019-08-24T14:15:22Z",
- "totalMinutesToWork": 0,
- "employeeID": 0,
- "dayModel": {
- "code": "string",
- "label": "string"
}, - "clockings": [
- {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z",
- "duration": 0
}
], - "dayParts": {
- "one": {
- "code": "string",
- "label": "string"
}, - "two": {
- "code": "string",
- "label": "string"
}
}, - "flexTime": 0
}
]Retrieves all comments attached to a specific worklog entry.
| worklogId required | number |
| debug | string |
[- {
- "commentId": "string",
- "comment": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "modifiedAt": "2019-08-24T14:15:22Z",
- "modifiedBy": "string",
- "deletedAt": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "commentType": {
- "commentTypeId": 0,
- "commentType": "string",
- "description": "string"
}, - "status": {
- "statusId": "string",
- "statusDate": "2019-08-24T14:15:22Z",
- "recipient": "string",
- "author": "string",
- "statusType": {
- "statusTypeId": 0,
- "statusType": "string",
- "description": "string"
}, - "comments": [
- { }
]
}
}
]Retrieves all available comment types. Comment types categorize the purpose of a worklog comment (e.g., general, internal, review).
| debug | string |
[- {
- "commentTypeId": 0,
- "commentType": "string",
- "description": "string"
}
]Retrieves homework data grouped by calendar quarters for a specific author and period.
| author required | string |
required | object (PeriodDto) |
[- {
- "homeWork": {
- "home": 0,
- "work": 0
}, - "q": {
- "quarter": 0,
- "year": 0
}
}
]Retrieves homework data grouped by calendar months for a specific author and period.
| author required | string |
required | object (PeriodDto) |
[- {
- "homeWork": {
- "home": 0,
- "work": 0
}, - "m": {
- "month": 0,
- "year": 0
}
}
]Retrieves homework data for a specific author and period, providing a granular view of work locations.
| author required | string |
required | object (PeriodDto) |
[- {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z",
- "homeWork": {
- "home": 0,
- "work": 0
}
}
]Retrieves detailed Jira issue information for a specific search term, including expanded properties.
| search required | string |
| expand required | string |
| debug | string |
[- {
- "id": "string",
- "key": "string",
- "url": "string",
- "summary": "string",
- "client": {
- "id": "string",
- "key": "string",
- "name": "string",
- "description": "string",
- "changedOn": "2019-08-24T14:15:22Z"
}, - "project": {
- "id": "string",
- "key": "string",
- "name": "string",
- "description": "string",
- "changedOn": "2019-08-24T14:15:22Z"
}, - "organiProject": "string",
- "issueType": {
- "id": "string",
- "key": "string",
- "name": "string",
- "description": "string",
- "changedOn": "2019-08-24T14:15:22Z",
- "iconUrl": "string"
}, - "status": {
- "id": "string",
- "key": "string",
- "name": "string",
- "description": "string",
- "changedOn": "2019-08-24T14:15:22Z",
- "iconUrl": "string"
}, - "fixVersions": [
- {
- "id": "string",
- "key": "string",
- "name": "string",
- "description": "string",
- "changedOn": "2019-08-24T14:15:22Z",
- "archived": true,
- "released": true,
- "releaseDate": "string"
}
], - "billable": true,
- "location": {
- "id": "string",
- "value": "string"
}, - "invoiceAs": {
- "id": "string",
- "value": "string"
}, - "parentInvoiceAs": {
- "id": "string",
- "value": "string"
}, - "parentOrganiProject": "string",
- "approvedBy": {
- "name": "string",
- "key": "string",
- "emailAddress": "string",
- "displayName": "string",
- "active": true
}, - "approveDate": "string",
- "finRemark": "string",
- "estimateCR": "string",
- "estimateDevelopment": "string",
- "etc": 0,
- "timeSpentSeconds": 0,
- "urgencyCall": {
- "id": "string",
- "value": "string"
}, - "resolutionDate": "2019-08-24T14:15:22Z",
- "resolution": {
- "id": "string",
- "key": "string",
- "name": "string",
- "description": "string",
- "changedOn": "2019-08-24T14:15:22Z"
}, - "components": [
- {
- "id": "string",
- "key": "string",
- "name": "string",
- "description": "string",
- "changedOn": "2019-08-24T14:15:22Z"
}
], - "jiraBillable": "string",
- "parentId": "string",
- "parentKey": "string",
- "parentIssueTypeId": "string",
- "parentIssueType": "string",
- "parentIssueSummary": "string",
- "parentIssueTypeIconUrl": "string",
- "jiraServerId": "string",
- "restrictions": [
- {
- "id": 0,
- "name": "string",
- "value": "string"
}
]
}
]Retrieves detailed information for a comma-separated list of Jira issue keys.
| search required | string |
| expand required | string |
| debug | string |
[- {
- "id": "string",
- "key": "string",
- "url": "string",
- "summary": "string",
- "client": {
- "id": "string",
- "key": "string",
- "name": "string",
- "description": "string",
- "changedOn": "2019-08-24T14:15:22Z"
}, - "project": {
- "id": "string",
- "key": "string",
- "name": "string",
- "description": "string",
- "changedOn": "2019-08-24T14:15:22Z"
}, - "organiProject": "string",
- "issueType": {
- "id": "string",
- "key": "string",
- "name": "string",
- "description": "string",
- "changedOn": "2019-08-24T14:15:22Z",
- "iconUrl": "string"
}, - "status": {
- "id": "string",
- "key": "string",
- "name": "string",
- "description": "string",
- "changedOn": "2019-08-24T14:15:22Z",
- "iconUrl": "string"
}, - "fixVersions": [
- {
- "id": "string",
- "key": "string",
- "name": "string",
- "description": "string",
- "changedOn": "2019-08-24T14:15:22Z",
- "archived": true,
- "released": true,
- "releaseDate": "string"
}
], - "billable": true,
- "location": {
- "id": "string",
- "value": "string"
}, - "invoiceAs": {
- "id": "string",
- "value": "string"
}, - "parentInvoiceAs": {
- "id": "string",
- "value": "string"
}, - "parentOrganiProject": "string",
- "approvedBy": {
- "name": "string",
- "key": "string",
- "emailAddress": "string",
- "displayName": "string",
- "active": true
}, - "approveDate": "string",
- "finRemark": "string",
- "estimateCR": "string",
- "estimateDevelopment": "string",
- "etc": 0,
- "timeSpentSeconds": 0,
- "urgencyCall": {
- "id": "string",
- "value": "string"
}, - "resolutionDate": "2019-08-24T14:15:22Z",
- "resolution": {
- "id": "string",
- "key": "string",
- "name": "string",
- "description": "string",
- "changedOn": "2019-08-24T14:15:22Z"
}, - "components": [
- {
- "id": "string",
- "key": "string",
- "name": "string",
- "description": "string",
- "changedOn": "2019-08-24T14:15:22Z"
}
], - "jiraBillable": "string",
- "parentId": "string",
- "parentKey": "string",
- "parentIssueTypeId": "string",
- "parentIssueType": "string",
- "parentIssueSummary": "string",
- "parentIssueTypeIconUrl": "string",
- "jiraServerId": "string",
- "restrictions": [
- {
- "id": 0,
- "name": "string",
- "value": "string"
}
]
}
]Retrieves available performance types. Performance types define the category of work performed (e.g., Development, Support, Administration).
| debug | string |
[- {
- "performanceTypeId": 0,
- "code": "string",
- "description": "string",
- "isAdministration": true
}
]Retrieves available link types. Link types define relationships between worklogs and external entities like Jira projects or customers.
| debug | string |
[- {
- "linkTypeId": 0,
- "linkType": "string",
- "description": "string"
}
]Retrieves link items that can be associated with worklogs to connect them to external metadata.
| debug | string |
[- {
- "linkItemId": "string",
- "id": "string",
- "value": "string",
- "linkType": {
- "linkTypeId": 0,
- "linkType": "string",
- "description": "string"
}
}
]Suggests a start and end time for the next worklog entry based on the author's previous worklogs and clocking data.
| author required | string |
| debug | string |
{- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z",
- "duration": 0
}Retrieves a specific worklog entry by its ID. Supports selection of fields and expansion of related entities.
| id required | number |
| select | Array of strings Items Enum: "description" "author" "startDate" "endDate" "performanceTypeId" "createdAt" "createdBy" "modifiedAt" "modifiedBy" Specifies what items should be returned. |
| expand | Array of strings Items Enum: "performanceType" "comment" "attribute" "status" "worklogLink" "worklogType" "s" "worklogStatus" "confirmationStatus" "actions" Specifies what tables should be expanded. |
| orderBy | Array of strings Specifies the on what expand tables should be ordered.
Example: '[comment.createdAt desc, comment.comment asc]' |
| debug | string |
{- "worklogId": 0,
- "worklogType": 0,
- "performanceType": 0,
- "currentStatusTypeId": 0,
- "description": "string",
- "author": "string",
- "createdBy": "string",
- "modifiedBy": "string",
- "jiraIssue": {
- "issueKey": "string"
}, - "attributes": [
- {
- "property1": "string",
- "property2": "string"
}
], - "comments": [
- {
- "comment": "string",
- "createdBy": "string",
- "modifiedBy": "string",
- "commentTypeId": 0,
- "statusId": 0
}
], - "statuses": [
- {
- "author": "string",
- "statusTypeId": 0
}
], - "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "actions": {
- "edit": true,
- "remove": true,
- "worklogApprove": true,
- "worklogAskReview": true,
- "worklogReview": true,
- "worklogUndoConfirm": true,
- "customerConfirm": true,
- "customerAskReview": true,
- "customerReview": true,
- "customerUndoConfirm": true
}
}Retrieves a list of worklog entries based on various filters (author, date, status, etc.). Supports pagination, field selection, and relationship expansion.
| filter | string Format: see type WorklogFilter |
| select | Array of strings Items Enum: "description" "author" "startDate" "endDate" "performanceTypeId" "createdAt" "createdBy" "modifiedAt" "modifiedBy" Specifies what items should be returned. |
| expand | Array of strings Items Enum: "performanceType" "comment" "attribute" "status" "worklogLink" "worklogType" "s" "worklogStatus" "confirmationStatus" "actions" Specifies what tables should be expanded. |
| orderBy | Array of strings Specifies the on what expand tables should be ordered.
Example: '[comment.createdAt desc, comment.comment asc]' |
| top | number |
| skip | number |
| countTotal | boolean |
| cacheId required | string |
| generateCache required | string |
| debug | string |
[- {
- "worklogId": 0,
- "worklogType": 0,
- "performanceType": 0,
- "currentStatusTypeId": 0,
- "description": "string",
- "author": "string",
- "createdBy": "string",
- "modifiedBy": "string",
- "jiraIssue": {
- "issueKey": "string"
}, - "attributes": [
- {
- "property1": "string",
- "property2": "string"
}
], - "comments": [
- {
- "comment": "string",
- "createdBy": "string",
- "modifiedBy": "string",
- "commentTypeId": 0,
- "statusId": 0
}
], - "statuses": [
- {
- "author": "string",
- "statusTypeId": 0
}
], - "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "actions": {
- "edit": true,
- "remove": true,
- "worklogApprove": true,
- "worklogAskReview": true,
- "worklogReview": true,
- "worklogUndoConfirm": true,
- "customerConfirm": true,
- "customerAskReview": true,
- "customerReview": true,
- "customerUndoConfirm": true
}
}
]Creates a new worklog entry. Validates Jira issue restrictions before saving.
| debug | string |
{- "worklogId": 0,
- "worklogType": 0,
- "performanceType": 0,
- "currentStatusTypeId": 0,
- "description": "string",
- "author": "string",
- "createdBy": "string",
- "modifiedBy": "string",
- "jiraIssue": {
- "issueKey": "string"
}, - "attributes": [
- {
- "property1": "string",
- "property2": "string"
}
], - "comments": [
- {
- "comment": "string",
- "createdBy": "string",
- "modifiedBy": "string",
- "commentTypeId": 0,
- "statusId": 0
}
], - "statuses": [
- {
- "author": "string",
- "statusTypeId": 0
}
], - "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "actions": {
- "edit": true,
- "remove": true,
- "worklogApprove": true,
- "worklogAskReview": true,
- "worklogReview": true,
- "worklogUndoConfirm": true,
- "customerConfirm": true,
- "customerAskReview": true,
- "customerReview": true,
- "customerUndoConfirm": true
}
}Updates an existing worklog entry. Checks for edit permissions and Jira issue restrictions.
| debug | string |
{- "worklogId": 0,
- "worklogType": 0,
- "performanceType": 0,
- "currentStatusTypeId": 0,
- "description": "string",
- "author": "string",
- "createdBy": "string",
- "modifiedBy": "string",
- "jiraIssue": {
- "issueKey": "string"
}, - "attributes": [
- {
- "property1": "string",
- "property2": "string"
}
], - "comments": [
- {
- "comment": "string",
- "createdBy": "string",
- "modifiedBy": "string",
- "commentTypeId": 0,
- "statusId": 0
}
], - "statuses": [
- {
- "author": "string",
- "statusTypeId": 0
}
], - "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "actions": {
- "edit": true,
- "remove": true,
- "worklogApprove": true,
- "worklogAskReview": true,
- "worklogReview": true,
- "worklogUndoConfirm": true,
- "customerConfirm": true,
- "customerAskReview": true,
- "customerReview": true,
- "customerUndoConfirm": true
}
}Retrieves the history of confirmation statuses (e.g., Approved by Customer) for a specific worklog.
| worklogId required | number |
| debug | string |
[- {
- "statusId": "string",
- "statusDate": "2019-08-24T14:15:22Z",
- "recipient": "string",
- "author": "string",
- "statusType": {
- "statusTypeId": 0,
- "statusType": "string",
- "description": "string"
}, - "comments": [
- {
- "commentId": "string",
- "comment": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "modifiedAt": "2019-08-24T14:15:22Z",
- "modifiedBy": "string",
- "deletedAt": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "commentType": {
- "commentTypeId": 0,
- "commentType": "string",
- "description": "string"
}, - "status": { }
}
]
}
]Retrieves the history of internal worklog statuses (e.g., To Approve, Reviewed) for a specific worklog.
| worklogId required | number |
| debug | string |
[- {
- "statusId": "string",
- "statusDate": "2019-08-24T14:15:22Z",
- "recipient": "string",
- "author": "string",
- "statusType": {
- "statusTypeId": 0,
- "statusType": "string",
- "description": "string"
}, - "comments": [
- {
- "commentId": "string",
- "comment": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "modifiedAt": "2019-08-24T14:15:22Z",
- "modifiedBy": "string",
- "deletedAt": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "commentType": {
- "commentTypeId": 0,
- "commentType": "string",
- "description": "string"
}, - "status": { }
}
]
}
]Updates the confirmation status of one or more worklogs. Used for customer approval flows.
| worklogIds required | Array of numbers |
| statusId required | number Enum: 6 7 8 9 10 12 different possible statuses: |
| comment | string |
{- "worklogIds": [
- 0
], - "statusId": 6,
- "comment": "string"
}{- "success": [
- "string"
], - "failed": [
- "string"
], - "denied": [
- "string"
]
}Updates the internal worklog status of one or more worklogs. Used for internal approval flows.
| worklogIds required | Array of numbers |
| statusId required | number Enum: 1 4 2 3 5 11 different possible statuses: |
| comment | string |
| orderNumber | string |
| invoiceNumber | string |
| invoiceDate | string <date-time> |
{- "worklogIds": [
- 0
], - "statusId": 1,
- "comment": "string",
- "orderNumber": "string",
- "invoiceNumber": "string",
- "invoiceDate": "2019-08-24T14:15:22Z"
}{- "success": [
- "string"
], - "failed": [
- "string"
], - "denied": [
- "string"
]
}Reverts the last worklog status change for one or more worklogs.
| worklogIds required | Array of numbers |
| statusId required | number Enum: 4 11 different possible statuses to undo:
|
| orderNumber | string |
{- "worklogIds": [
- 0
], - "statusId": 4,
- "orderNumber": "string"
}{- "success": [
- "string"
], - "failed": [
- "string"
], - "denied": [
- "string"
]
}Reverts the last confirmation status change for one or more worklogs.
| worklogIds required | Array of numbers |
| statusId required | number Enum: 6 7 8 9 12 different possible statuses to undo:
|
{- "worklogIds": [
- 0
], - "statusId": 6
}{- "success": [
- "string"
], - "failed": [
- "string"
], - "denied": [
- "string"
]
}