Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Value type

Optional

Description

worklogId

number

false

The internal ID of the worklog to patch.

jiraWorklogId

number

true

The ID of the worklog as stored in Jira.

partialWorklog

PartialWorklog

false

The patch to apply on the worklog. Only the fields with defined values will be updated.

...

Parameter

Value type

Optional

Description

description

string

true

The description of a worklog.

durationInSeconds

number

true

The duration of a worklog in seconds.

isBillable

boolean

true

True if the worklog is billable.

issueId

number

true

The worklog was made on this issue.

workDate

string

true

The day (ISO-8601 date in 'yyyy-MM-dd' format) when the work was made.

worklogTagIds

number[]

true

The IDs of the worklog tags assigned to this worklog.

workStartTime

string

true

The time (ISO-8601 time in 'HH:mm' format) when the work was started.

Examples

  • PATCH URL: TIME_TRACKER_BASE_URL/timetracker/api/latest/public/worklog

Example patch body:

Code Block
{
    "partialWorklog": {
        "description": "test description",
        "durationInSeconds": 3600,
        "isBillable": true,
        "issueId": 10329,
        "workDate": "2023-04-19",
        "worklogTagIds": [1, 5],
        "workStartTime": "08:15"
    },
    "worklogId": 181
}

...

Query Parameter

Value type

Optional

Description

worklogId

number

false

The internal app id of the worklog.

Example: /public/worklog?worklogId=107

jiraWorklogId

number

true

The id of the worklog in Jira.

Example: /public/worklog?jiraWorklogId=230818

Examples

  • GET URL: TIME_TRACKER_BASE_URL/timetracker/api/latest/public/worklog?worklogId=155

Example response:

200 Successful operation:

  • GET URL: TIME_TRACKER_BASE_URL/timetracker/api/latest/public/worklog?jiraWorklogId=230818

Example response:

200 Successful operation:

Code Block
{
    "description": "my description",
    "durationInSeconds": 3600,
    "isBillable": true,
    "issueId": 10182,
    "jiraWorklogId": 230818,
    "workDate": "2023-04-24",
    "worklogId": 155,
    "worklogTagIds": [
        1,
        5
    ],
    "workStartTime": "12:00"
}

...

Query Parameter

Value type

Optional

Description

worklogId

number

false

The id of the worklog.

Example: /public/worklog?worklogId=107

jiraWorklogId

number

true

The id of the worklog in Jira.

Example: /public/worklog?jiraWorklogId=230818

Examples

  • DELETE URL: TIME_TRACKER_BASE_URL/timetracker/api/latest/public/worklog?worklogId=123

  • DELETE URL: TIME_TRACKER_BASE_URL/timetracker/api/latest/public/worklog?jiraWorklogId=230818

Example response:

200 The delete operation is accepted and processed. The result of the worklog delete can be found in the response body:

...