Class TimeTrackingService

This resource represents time tracking and time tracking providers. Use it to get and set the time tracking provider, get and set the time tracking options, and disable time tracking.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-time-tracking

Hierarchy

CommonHttpService
- TimeTrackingService

Index

Constructors

constructor

Methods

getAvailableTimeTrackingImplementations getSelectedTimeTrackingImplementation getSharedTimeTrackingConfiguration selectTimeTrackingImplementation setSharedTimeTrackingConfiguration initialize

Constructors

constructor

new TimeTrackingService(getClientInstance): TimeTrackingService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns TimeTrackingService
Inherited from CommonHttpService.constructor

Methods

getAvailableTimeTrackingImplementations

getAvailableTimeTrackingImplementations(): Promise<TimeTrackingProvider[]>
Returns all time tracking providers. By default, Jira only has one time tracking provider: JIRA provided time tracking. However, you can install other time tracking providers via apps from the Atlassian Marketplace. For more information on time tracking providers, see the documentation for the Time Tracking Provider module.

Permissions required: Administer Jira global permission.

Returns Promise<TimeTrackingProvider[]>
Returned if the request is successful.

example:
```
[
  {
    "key": "Jira",
    "name": "JIRA provided time tracking",
    "url": "/example/config/url"
  }
]
```
Path
GET /rest/api/3/configuration/timetracking/list @scopes-current manage:jira-configuration @scopes-beta read:issue.time-tracking:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-time-tracking#api-rest-api-3-configuration-timetracking-list-get

getSelectedTimeTrackingImplementation

getSelectedTimeTrackingImplementation(): Promise<WithResponse<{
    body: TimeTrackingProvider;
    mediaType: "application/json";
    status: 200;
} | {
    body: void;
    mediaType: "application/json";
    status: 204;
}>>
Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a successful but empty response is returned.

Permissions required: Administer Jira global permission.

Returns Promise<WithResponse<{
    body: TimeTrackingProvider;
    mediaType: "application/json";
    status: 200;
} | {
    body: void;
    mediaType: "application/json";
    status: 204;
}>>
- status: 200, mediaType: application/json
  
  Returned if the request is successful and time tracking is enabled.
  
  example:
```
{
  "key": "Jira",
  "name": "JIRA provided time tracking",
  "url": "/example/config/url"
}
```
- status: 204, mediaType: application/json
  
  Returned if the request is successful but time tracking is disabled.
Path
GET /rest/api/3/configuration/timetracking @scopes-current manage:jira-configuration @scopes-beta read:issue.time-tracking:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-time-tracking#api-rest-api-3-configuration-timetracking-get

getSharedTimeTrackingConfiguration

getSharedTimeTrackingConfiguration(): Promise<TimeTrackingConfiguration>
Returns the time tracking settings. This includes settings such as the time format, default time unit, and others. For more information, see Configuring time tracking.

Permissions required: Administer Jira global permission.

Returns Promise<TimeTrackingConfiguration>
Returned if the request is successful.

example:
```
{
  "defaultUnit": "hour",
  "timeFormat": "pretty",
  "workingDaysPerWeek": 5.5,
  "workingHoursPerDay": 7.6
}
```
Path
GET /rest/api/3/configuration/timetracking/options @scopes-current manage:jira-configuration @scopes-beta read:issue.time-tracking:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-time-tracking#api-rest-api-3-configuration-timetracking-options-get

selectTimeTrackingImplementation

selectTimeTrackingImplementation(params): Promise<void>
Selects a time tracking provider.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  timeTrackingProvider: TimeTrackingProvider;
  }
  - timeTrackingProvider: TimeTrackingProvider
    Example
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/configuration/timetracking @scopes-current manage:jira-configuration @scopes-beta write:issue.time-tracking:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-time-tracking#api-rest-api-3-configuration-timetracking-put

setSharedTimeTrackingConfiguration

setSharedTimeTrackingConfiguration(params): Promise<TimeTrackingConfiguration>
Sets the time tracking settings.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  timeTrackingConfiguration: TimeTrackingConfiguration;
  }
  - timeTrackingConfiguration: TimeTrackingConfiguration
    Example
Returns Promise<TimeTrackingConfiguration>
Returned if the request is successful.

example:
```
{
  "defaultUnit": "hour",
  "timeFormat": "pretty",
  "workingDaysPerWeek": 5.5,
  "workingHoursPerDay": 7.6
}
```
Path
PUT /rest/api/3/configuration/timetracking/options @scopes-current manage:jira-configuration @scopes-beta write:issue.time-tracking:jira, read:issue.time-tracking:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-time-tracking#api-rest-api-3-configuration-timetracking-options-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class TimeTrackingService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns TimeTrackingService

Methods

getAvailableTimeTrackingImplementations

Returns Promise<TimeTrackingProvider[]>

Path

See

getSelectedTimeTrackingImplementation

Returns Promise<WithResponse<{ body: TimeTrackingProvider; mediaType: "application/json"; status: 200; } | { body: void; mediaType: "application/json"; status: 204; }>>

Path

See

getSharedTimeTrackingConfiguration

Returns Promise<TimeTrackingConfiguration>

Path

See

selectTimeTrackingImplementation

Parameters

timeTrackingProvider: TimeTrackingProvider

Example

Returns Promise<void>

Path

See

setSharedTimeTrackingConfiguration

Parameters

timeTrackingConfiguration: TimeTrackingConfiguration

Example

Returns Promise<TimeTrackingConfiguration>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

Returns Promise<WithResponse<{
body: TimeTrackingProvider;
mediaType: "application/json";
status: 200;
} | {
body: void;
mediaType: "application/json";
status: 204;
}>>

`Protected` `Static`initialize