Worklog API

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/latest/public

Create worklog POST /worklog

Header parameters

Body

The POST body is a JSON object: NewWorklog

The available parameters of the NewWorklog:

Examples

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

Example post body:

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

Example response:

200 Successful operation:

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

400 Invalid parameters:

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

{
  // Errors that are not tied to any specific field.
  "additionalErrors": [
    {
      "errorType": "JiraError" | "PeriodicLimit" | "PeriodicLoggablePeriod" | "PeriodicMaxHoursPerDay" | "TooManyDataForTimesheet" | "TooManyWorklogsToExport" | "NoActiveLicense" | "ManualUpgradeNeeded"
      "extra": // A field holding additional 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"
        ]
      ]
    }
  ]
}

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

Body

The PATCH body is a JSON object: PatchWorklog

The available parameters of the PatchWorklog:

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

The available parameters of the PartialWorklog:

Examples

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

Example patch body:

{
    "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

    {
        "error": null,
        "worklog": {
            "description": "test description",
            "durationInSeconds": 10800,
            "isBillable": true,
            "issueId": 10329,
            "workDate": "2023-04-19",
            "worklogId": 181,
            "worklogTagIds": [
                1,
                5
            ],
            "workStartTime": "08:15"
        }
    }

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

  • CODE

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

400 Invalid parameters:

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

{
  // Errors that are not tied to any specific field.
  "additionalErrors": [
    {
      "errorType": "JiraError" | "PeriodicLimit" | "PeriodicLoggablePeriod" | "PeriodicMaxHoursPerDay" | "TooManyDataForTimesheet" | "TooManyWorklogsToExport" | "NoActiveLicense" | "ManualUpgradeNeeded"
      "extra": // A field holding additional 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"
        ]
      ]
    }
  ]
}

401 Unauthorized

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

Get worklog GET /worklog

Header parameters

Query Parameters

The available query parameters for the request:

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?jiraWorklogId=230818

Example response:

200 Successful operation:

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

• 400

  • Invalid parameters:

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

      CODE

      {
        // Errors that are not tied to any specific field.
        "additionalErrors": [
          {
            "errorType": "JiraError" | "PeriodicLimit" | "PeriodicLoggablePeriod" | "PeriodicMaxHoursPerDay" | "TooManyDataForTimesheet" | "TooManyWorklogsToExport" | "NoActiveLicense" | "ManualUpgradeNeeded"
            "extra": // A field holding additional 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

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

401 Unauthorized

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

Delete worklog DELETE /worklog

Header parameters

Query Parameters

The available query parameters for the request:

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

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:

• If there was no error during the deletion the error object will be null:

  • CODE

    {
        "error": null
    }

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

  • CODE

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

400 Invalid parameters:

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

{
  // Errors that are not tied to any specific field.
  "additionalErrors": [
    {
      "errorType": "JiraError" | "PeriodicLimit" | "PeriodicLoggablePeriod" | "PeriodicMaxHoursPerDay" | "TooManyDataForTimesheet" | "TooManyWorklogsToExport" | "NoActiveLicense" | "ManualUpgradeNeeded"
      "extra": // A field holding additional 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"
        ]
      ]
    }
  ]
}

401 Unauthorized

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