Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 4 Next »

Timetracker version 4.7.5 or higher is required to access this API

JIRA Administrators or JIRA System Administrators permission required for the user this service

Timetracker worklog attributes can be managed via this Service:

  • Query worklog attributes

  • Add worklog attributes

  • Update worklog attributes

  • Delete worklog attributes

API

package org.everit.jira.reporting.service.attribute;

import java.util.List;

/**
 * Public Worklog Attribute Service.
 */
public interface WorklogAttributeService {

  /**
   * Delete worklog attribute. Requires System Administrator or Administrator jira permission.
   *
   * @param worklogAttributeName
   *          the name of the worklog attribute.
   */
  void deleteWorklogAttribute(final String worklogAttributeName);

  /**
   * List worklog attribute names. Requires System Administrator or Administrator jira permission., else returns an empty list.
   */
  List<String> listWorklogAttributes();

  /**
   * Create or Update worklog attribute names. Requires System Administrator or Administrator jira permission. 
   *
   * @param worklogAttributeNames
   *          the worklog attribute names.
   */
  void updateWorklogAttributes(final List<String> worklogAttributeNames);
}

Example

import com.onresolve.scriptrunner.runner.customisers.PluginModule;
import java.time.LocalDate;
import com.onresolve.scriptrunner.runner.customisers.WithPlugin;
import org.everit.jira.reporting.service.attribute.WorklogAttributeService;
import java.util.Arrays;


@WithPlugin("org.everit.jira.timetracker.plugin")

@PluginModule
WorklogAttributeService worklogAttributeService;


log.error(worklogAttributeService.listWorklogAttributes());

worklogAttributeService.updateWorklogAttributes(Arrays.asList("billable", "not-billable"));

log.error(worklogAttributeService.listWorklogAttributes());

worklogAttributeService.deleteWorklogAttribute("billable");

log.error(worklogAttributeService.listWorklogAttributes());

worklogAttributeService.deleteWorklogAttribute("not-billable");

log.error(worklogAttributeService.listWorklogAttributes());

  • No labels