Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

Create, Update, View or Delete worklogs with the same restrictions and rules as you would within the app.

All requests need to be made to this base URL:

https://jttp-cloud.everit.biz/timetracker/api/<REST_API_VERSION>latest/public

Create worklog POST /worklog

...

Header Parameter

Optional

Description

x-everit-jwt

false

JWT token, see: REST API

x-requested-by

false

CSRF protection parameter. Can be empty or any dummy text.

x-timezone

true

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

...

POST URL: TIME_TRACKER_BASE_URL/timetracker/api/22latest/public/worklog

Example post body:

...

Code Block
{
  // Errors that are not tied to any specific field.
  "additionalErrors": [
    {
      "errorType": "JiraError" | "PeriodicLimit" | "PeriodicLoggablePeriod" | "PeriodicMaxHoursPerDay" | "TooManyDataForTimesheet" | "TooManyWorklogsToExport" | "NoActiveLicense" | "ManualUpgradeNeeded"
      "extra": // A field holding aditionaladditional information related to the error
    }
  ],
  // Error response data for fields.
  "fieldErrors": [
    {
      "errorType": "Exceed" | "Invalid" | "InvalidByJira" | "InvalidFormat" | "LoggablePeriod" | "MaxHoursPerDay" | "Required" | "TooManyPeriodicIssues",
      // An array of string arrays containing the problematic field names.
      "paths": [
        [
          "string"
        ]
      ]
    }
  ]
}

...

Header Parameter

Optional

Description

x-everit-jwt

false

JWT token, see: REST API

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.

...

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

Example patch body:

...

Code Block
{
  // Errors that are not tied to any specific field.
  "additionalErrors": [
    {
      "errorType": "JiraError" | "PeriodicLimit" | "PeriodicLoggablePeriod" | "PeriodicMaxHoursPerDay" | "TooManyDataForTimesheet" | "TooManyWorklogsToExport" | "NoActiveLicense" | "ManualUpgradeNeeded"
      "extra": // A field holding aditionaladditional information related to the error
    }
  ],
  // Error response data for fields.
  "fieldErrors": [
    {
      "errorType": "Exceed" | "Invalid" | "InvalidByJira" | "InvalidFormat" | "LoggablePeriod" | "MaxHoursPerDay" | "Required" | "TooManyPeriodicIssues",
      // An array of string arrays containing the problematic field names.
      "paths": [
        [
          "string"
        ]
      ]
    }
  ]
}

...

Header Parameter

Optional

Description

x-everit-jwt

false

JWT token, see: REST API

x-timezone

true

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

...

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

...

  • 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": "JiraError" | "PeriodicLimit" | "PeriodicLoggablePeriod" | "PeriodicMaxHoursPerDay" | "TooManyDataForTimesheet" | "TooManyWorklogsToExport" | "NoActiveLicense" | "ManualUpgradeNeeded"
              "extra": // A field holding aditionaladditional information related to the error
            }
          ],
          // Error response data for fields.
          "fieldErrors": [
            {
              "errorType": "Exceed" | "Invalid" | "InvalidByJira" | "InvalidFormat" | "LoggablePeriod" | "MaxHoursPerDay" | "Required" | "TooManyPeriodicIssues",
              // An array of string arrays containing the problematic field names.
              "paths": [
                [
                  "string"
                ]
              ]
            }
          ]
        }
    • WorklogError:

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

...

Header Parameter

Optional

Description

x-everit-jwt

false

JWT token, see: REST API

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.

...

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

...

Code Block
{
  // Errors that are not tied to any specific field.
  "additionalErrors": [
    {
      "errorType": "JiraError" | "PeriodicLimit" | "PeriodicLoggablePeriod" | "PeriodicMaxHoursPerDay" | "TooManyDataForTimesheet" | "TooManyWorklogsToExport" | "NoActiveLicense" | "ManualUpgradeNeeded"
      "extra": // A field holding aditionaladditional information related to the error
    }
  ],
  // Error response data for fields.
  "fieldErrors": [
    {
      "errorType": "Exceed" | "Invalid" | "InvalidByJira" | "InvalidFormat" | "LoggablePeriod" | "MaxHoursPerDay" | "Required" | "TooManyPeriodicIssues",
      // An array of string arrays containing the problematic field names.
      "paths": [
        [
          "string"
        ]
      ]
    }
  ]
}

...