Versions Compared

Version Old Version 8 New Version Current
Changes made by

Attila Bordás

Norbert Soós

Saved on

Key

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

...

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

400 Invalid parameters:

An object that holds all field and non-field related errors:

Code Block
{[
   // Errors that are{
not tied to any specific field.   "additionalErrorsid": [
  1,
 {       "errorTypename": "JiraErrordevelopment"
 | "PeriodicLimit" | "PeriodicLoggablePeriod" | "PeriodicMaxHoursPerDay" | "TooManyDataForTimesheet" | "TooManyWorklogsToExport" | "NoActiveLicense" | "ManualUpgradeNeeded"  },
      {
        "extraid": //5,
A field holding additional information related to the error
 "name": "testing"
  }   ], }
 // Error response data],
for fields.   "fieldErrorsworkStartTime": "12:00"
}

400 Invalid parameters:

An object that holds all field and non-field related errors:

Code Block
{
  // Errors that are not tied to any specific field.
  "additionalErrors": [
    {
      "errorType": "ExceedJiraError" | "InvalidPeriodicLimit" | "InvalidByJiraPeriodicLoggablePeriod" | "InvalidFormatPeriodicMaxHoursPerDay" | "LoggablePeriodTooManyDataForTimesheet" | "MaxHoursPerDayTooManyWorklogsToExport" | "RequiredNoActiveLicense" | "TooManyPeriodicIssuesManualUpgradeNeeded",
      "extra": // A Anfield arrayholding ofadditional stringinformation arraysrelated containingto the problematicerror
 field names.  }
  ],
 "paths": [
     // Error response data for fields.
  "fieldErrors": [
    {
      "stringerrorType": "Exceed" | "Invalid" | "InvalidByJira" | "InvalidFormat" | ]"LoggablePeriod" | "MaxHoursPerDay" | "Required" | "TooManyPeriodicIssues",
]     } // An ]
}

401 Unauthorized

479 The user does not have one of the necessary Timetracker permissions that can be set in the Global Settings.

Update worklog PATCH /worklog

Header parameters

...

Header Parameter

...

Optional

...

Description

...

x-everit-api-key

...

false

...

Generated Everit authentication token, see: REST API

...

x-everit-jwt deprecated

...

false

...

array of string arrays containing the problematic field names.
      "paths": [
        [
          "string"
        ]
      ]
    }
  ]
}

401 Unauthorized

479 The user does not have one of the necessary Timetracker permissions that can be set in the Global Settings.

Update worklog PATCH /worklog

Header parameters

Header Parameter

Optional

Description

x-everit-api-key instead)x-requested-by

falseCSRF protection paramter.

Generated Everit authentication token, see: REST API

x-everit-timezonejwt deprecated

true

The false

JWT token (deprecated, use the new x-everit-api-key instead)

x-requested-by

false

CSRF protection paramter.

x-timezone

true

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

x-everit-on-behalf-account

true

The account id of the on behalf user.

...

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:

...

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,
    "jiraWorklogId": 230818,
}

Example response:

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

  • If there was no error during the patch the error object will be null and the patched worklog is returned:

    • Code Block
      {
    "error": null,
    "worklog": {
        "description": "test description",
        "durationInSeconds":

...

    • 10800,
        "isBillable": true,
        "issueId": 10329,
        "workDate": "2023-04-19",
        "

...

    • worklogId":

...

    • 181,
        "

...

    • worklogTagIds":

...

    • [

...

    •

...

    •

...

Example response:

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

  • If there was no error during the patch the error object will be null and the patched worklog is returned:

    • Code Block
      {
    "error": null,  1,
         "worklog": {  5
      "description": "test description"],
        "durationInSecondsworklogTags": 10800, [
          {
            "isBillableid": true1,
            "issueIdname": 10329, "development"
          },
   "workDate": "2023-04-19",      {
  "worklogId": 181,         "worklogTagIdsid": [5,
            1,
"name": "testing"
           5}
        ],
        "workStartTime": "08:15"
    }
}

  • If there was an error during the patch the error object will be filled:

    • Code Block
      {
    "error": {
        "message": null,
        "result": "WORKLOG_NOT_FOUND",
        "worklogId": 181
    },
    "worklog": null
}

...

(info) You either use “worklogId” or “jiraWorklogId”. If both are specified, “worklogId” is stronger.

...

Examples

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

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

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

Example response:

200 Successful operation:

...

  • 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,
    "descriptionworklogTagIds": [
 "my description",       1,
        5
    ],
    "worklogTags": [
      {
        "durationInSecondsid": 36001,
    "isBillable": true,   "name":  "issueIddevelopment":
10182,     "jiraWorklogId": 230818},
    "workDate": "2023-04-24",
  {
  "worklogId": 155,     "worklogTagIdsid": [5,
        1,
"name": "testing"
       5}
    ],
    "workStartTime": "12:00"
}

...