Versions Compared

Old Version 1

changes.mady.by.user Attila Bordás

Saved on

compared with

New Version 2

changes.mady.by.user Attila Bordás

Saved on

Key

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

Create worklog POST public/worklog

To create a worklog send a POST request to this URL: <TIME_TRACKER_BASE_URL>/timetracker/api/<REST_API_VERSION>/public/worklog

Header parameters

...

Header Parameter

Optional

Description

x-everit-jwt

false

jwt token

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.

Body

The POST body is a JSON object: NewWorklog

...

Parameter

Value

Optional

Description

description

string

true

The description of a worklog.

Example: “description”: “my description“

durationInSeconds

number

true

The duration of a worklog in seconds.
Example: “durationInSeconds”: 3600

isBillable

boolean

true

True if the worklog is billable.

Example: “isBillable”: true

issueId

number

true

The worklog was made on this issue.

Example: “issueId”: 10000

workDate

string

false

The day (ISO-8601 date in 'yyyy-MM-dd' format) when the work was made.

Example: “workDate”: “2023-04-24“

worklogTagIds

number list

true

The IDs of the worklog tags assigned to this worklog.

Example: “worklogTagIds”: [1, 5]

workStartTime

string

true

The time (ISO-8601 time in 'HH:mm' format) when the work was started.

Example: “workStartTime”: "11:00"

Examples

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

...

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

...

Update worklog PATCH public/worklog

To get patch a worklog send a GET PATCH request to this URL: <TIME_TRACKER_BASE_URL>/timetracker/api/<REST_API_VERSION>/public/worklog

Header parameters

...

Header Parameter

Optional

Description

x-everit-jwt

false

jwt token

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.

Body

The PATCH body is a JSON object: PatchWorklog

The available query parameters for the requestavailable parameters of the PatchWorklog:

Query

Parameter

Value

Optional

Description

worklogId

number

false

The

id of the worklog.

Example: /public/worklog?worklogId=107

...

ID of the worklog to patch.

partialWorklog

PartialWorklog

false

The patch to apply on the worklog. Only the fields with values will be updated.

The available parameters of the PartialWorklog:

Parameter

Value

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 list

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/22/public/worklog?worklogId=155

Example response:200 Successful operationpatch body:

Code Block
{
    "partialWorklog": {
        "description": "mytest description",
        "durationInSeconds": 3600,
        "isBillable": true,
        "issueId": 1018210329,
        "workDate": "2023-04-2419",

   "worklogId": 155,     "worklogTagIds": [1, 5],
       1, "workStartTime": "08:15"
      5
    ]},
    "workStartTimeworklogId": "12:00"181
}

400

...

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:
The available query parameters for the request:
...
Query Parameter
...
Value
...
Optional
...
Description
...
worklogId
...
number
...
false
...
The id of the worklog.
Example: /public/worklog?worklogId=107
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
      {
    "
      additionalErrors
      error": null,

      [
          "worklog": {
        "
      errorType
      description": "
      JiraError
      test description",
        "
      extra
      durationInSeconds": 
      {}
      10800,
    
      }
         
      ],
       
        
      "
      fieldErrors
      isBillable": 
      [
  
      true,
 
      {
             "
      errorType
      issueId": 
      "Exceed"
      10329,
        "
      paths
      workDate": 
      [
      "2023-04-19",
        
      [

      "worklogId": 181,
        
       
      "
      string
      worklogTagIds": [
       
      ]
           
        ]

      1,
   
      }
         
      ]
       
      }
      WorklogError:
       Code Block{
           
      "error":
      5

      {
              
       "message": null
      ],
        "
      result
      workStartTime": "
      WORKLOG_NOT_FOUND",
      08:15"
    
          "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
To delete a worklog send a DELETE request to this URL: <TIME_TRACKER_BASE_URL>/timetracker/api/<REST_API_VERSION>/public/worklog
Header parameters:
...
Header Parameter
...
Optional
...
Description
...
x-everit-jwt
...
false
...
jwt token
...
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.
    •  Code Block
      {
    "error": null
}
  • If there was an error during the deletion patch the error object will be filled:
    •  Code Block
      {
    "error": {
        "message": null,
        "result": "WORKLOG_NOT_FOUND",
        "worklogId": 123181
    },
    "worklog": null
}
400 Invalid parameters:
 Code Block
{
  "additionalErrors": [
    {
      "errorType": "JiraError",
      "extra": {}
    }
  ],
  "fieldErrors": [
    {
      "errorType": "Exceed",
      "paths": [
        [
          "string"
        ]
      ]
    }
  ]
}
...
479 The user does not have one of the necessary Timetracker permissions that can be set in the Global Settings.
...
Get worklog GET public/worklog
To patch get a worklog send a PATCH GET request to this URL: <TIME_TRACKER_BASE_URL>/timetracker/api/<REST_API_VERSION>/public/worklog
Header parameters
...
Header Parameter
Optional
Description
x-everit-jwt
false
jwt token
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.
The PATCH body is a JSON object: PatchWorklog
The available parameters of the PatchWorklog:
Query Parameters
The available query parameters for the request:
Query Parameter
Value
Optional
Description
worklogId
number
false
The 
 ID 
id of the worklog
 to patch.
partialWorklog
PartialWorklog
false
The patch to apply on the worklog. Only the fields with values will be updated.
The available parameters of the PartialWorklog:
...
Parameter
...
Value
...
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 list
...
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.
...
.
Example: /public/worklog?worklogId=107
Examples
GET URL: TIME_TRACKER_BASE_URL/timetracker/api/22/public/worklog?worklogId=155
Example patch bodyresponse:
200 Successful operation:
 Code Block
{
    "partialWorklog": {
        "description": "testmy description",
  
     "durationInSeconds": 3600,
   
    "isBillable": true,
   
    "issueId": 1032910182,
   
    "workDate": "2023-04-1924",
    "worklogId": 155,
    "worklogTagIds": [
        1,
5],        5
"workStartTime": "08:15"     }],
    "worklogIdworkStartTime": 181"12:00"
}
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 returned400 
    • Invalid parameters:
      •  Code Block
        {
      
 
      • 
  "
      error
      • additionalErrors": 
      null,

      • [
   
      "worklog":
      •  {
      
 
      • 
      "
      description
      • errorType": "
      test description
      • JiraError",
      
        
      • "
      durationInSeconds
      • extra": 
      10800,
      • {}
    }
  ],
  "
      isBillable
      • fieldErrors": [
  
      true,
      •   {
      "
      issueId
      • errorType": 
      10329
      • "Exceed",
      

      • 
      
       
      • "
      workDate
      • paths":
       "2023-04-19",
      •  [
        [

      "worklogId":
      •  
      181,
      •          "
      worklogTagIds": [
      • string"
        ]
      ]
  
      1,
      •   }
  ]
}
    • WorklogError:
      •  Code Block
        {
    "error": {

      5
      •         "message": 
      ]
      • null,
        "
      workStartTime
      • result": "WORKLOG_NOT_FOUND",
  
      "08:15"
      •       "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 public/worklog
To delete a worklog send a DELETE request to this URL: <TIME_TRACKER_BASE_URL>/timetracker/api/<REST_API_VERSION>/public/worklog
Header parameters
Header Parameter
Optional
Description
x-everit-jwt
false
jwt token
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.
Query Parameters
The available query parameters for the request:
Query Parameter
Value
Optional
Description
worklogId
number
false
The id of the worklog.
Example: /public/worklog?worklogId=107
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 patch deletion the error object will be filled:
    •  Code Block
      {
    "error": {
        "message": null,
        "result": "WORKLOG_NOT_FOUND",
        "worklogId": 181123
    },
    "worklog": null
}
400 Invalid parameters:
 Code Block
{
  "additionalErrors": [
    {
      "errorType": "JiraError",
      "extra": {}
    }
  ],
  "fieldErrors": [
    {
      "errorType": "Exceed",
      "paths": [
        [
          "string"
        ]
      ]
    }
  ]
}
...