Page Comparison

All requests need to be made to this base URL:

https://jttp-cloud.everit.biz/timetracker/api/<REST_API_VERSION>/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/22/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,
    "workDate": "2023-04-24",
    "worklogId": 155,
    "worklogTagIds": [
        1,
        5
    ],
    "workStartTime": "12:00"
}

400 Invalid parameters:

{
  "additionalErrors": [
    {
      "errorType": "JiraError",
      "extra": {}
    }
  ],
  "fieldErrors": [
    {
      "errorType": "Exceed",
      "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:

The available parameters of the PartialWorklog:

Examples

PATCH URL: TIME_TRACKER_BASE_URL/timetracker/api/22/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
}

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": [ 1, 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 }

400 Invalid parameters:

{
  "additionalErrors": [
    {
      "errorType": "JiraError",
      "extra": {}
    }
  ],
  "fieldErrors": [
    {
      "errorType": "Exceed",
      "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:

Examples

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

Example response:

200 Successful operation:

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

• 400

  • Invalid parameters:

    • Code Block
      { "additionalErrors": [ { "errorType": "JiraError", "extra": {} } ], "fieldErrors": [ { "errorType": "Exceed", "paths": [ [ "string" ] ] } ] }

  • WorklogError:

    • Code Block
      { "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:

Examples

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

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 Block
    {     "error": null }

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

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

400 Invalid parameters:

{
  "additionalErrors": [
    {
      "errorType": "JiraError",
      "extra": {}
    }
  ],
  "fieldErrors": [
    {
      "errorType": "Exceed",
      "paths": [
        [
          "string"
        ]
      ]
    }
  ]
}

401 Unauthorized

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