Versions Compared

Key

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

...

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

Example response:

200 Successful operation:

Code Block
{
    "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"
        ]
      ]
    }
  ]
}

401 Unauthorized

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

...

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

Code Block
{
  "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 URL: TIME_TRACKER_BASE_URL/timetracker/api/22/public/worklog?worklogId=155

Example response:

200 Successful operation:

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

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