Are changes being made to the servlet API?

Yes. We have decided to update our handling of API requests by deprecating the API Servlet at the end of this year. Instead, you will communicate to Tempo via REST APIs. This means the Servlet API won't be available for our cloud version for JIRA after we have deprecated it. These changes should not affect your daily work as you will not notice the transition period upon migration to the new version. Below you will find a table that will take you to more information about each feature that has now been deprecated and how you can retrieve this information either with the Tempo REST API or the JIRA REST API.

Theme Feature being deprecated Announced on
Servlet APIs updateWorklogs June 6, 2017
getWorklogReport  June 6, 2017
billingKeyList  June 6, 2017
holidayList  June 6, 2017
JIRA fields June 6, 2017
format=excel June 6, 2017

 

 

 

 

updateWorklogs 

The updateWorklogs servlet API is not a highly used feature and we feel that it is not our responsibility to check if worklogs have been modified since they were last exported to an external system. That external system should be responsible for handling these sorts of use cases, which is why the feature is being deprecated.

getWorklogReport

The getWorklogReport servlet API is not a highly used feature, which is why it is being deprecated.

billingKeyList

While the billingKeyList servlet API is being deprecated, it is possible to use the TEMPO REST API to retrieve this information, as it consists of a list of available accounts to be used when creating reports.

For example, the string below retrieves all accounts that the logged-in user has permission to browse:

GET http://{JIRA_BASE_URL}/rest/tempo-accounts/1/account/

holidayList

Following the development of a new version of Tempo Cloud for JIRA, we have decided to deprecate the HolidayList API, which until had been a part of the Servlet API. The HolidayList returned a list of registered non-working days (holidays) to be used when calculating required hours in an external system.

 From now on, communications to Tempo will go through REST APIs.

JIRA fields

The following JIRA fields are no longer supported in the getWorklogs service. They can be retrieve using JIRA REST APIs.

addIssueSummary:

This will retrieve the issue summary for the given issue key:
 
/rest/api/2/issue/{issueKey}?fields=summary
 
Example:
 
Returns:
{
  "expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations",
  "id": "10000",
  "key": "{issueKey}",
  "fields": {
    "summary": "This is a issue summary"
  }
}
 

addIssueDetails:

 
This will retrieve details such as issue type, original estimate, remaining estimate, version, component, project key, project category, project name and issue priority:
 
This is not possible like the servlet does it but instead the customer can get all the information about the issue.
 
Gets a full representation of the issue for the given issue key:
 
/rest/api/2/issue/{issueKey}
 
 

addUserDetails:

 
This will retrieve user details such as user full name and all JIRA user properties:
 
/rest/api/2/user?username={userName}
 
Example:
 
Returns:
{
  "key": "admin",
  "name": "admin",
  "emailAddress": "admin@nomail.com",
  "avatarUrls": {
  },
  "displayName": "Admin  [Administrator]",
  "active": true,
  "timeZone": "Etc/GMT",
  "locale": "en_US",
  "groups": {
    "size": 9,
    "items": []
  },
  "applicationRoles": {
    "size": 3,
    "items": []
  },
  "expand": "groups,applicationRoles"
}
 

addIssueDescription:

 
This will retrieve the issue description field for the given issue key:
 
/rest/api/2/issue/{issueKey}?fields=description
 
Example:
 
Returns:
{
  "expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations",
  "id": "10000",
  "key": "T-1",
  "fields": {
    "description": "Issue description\r\n"
  }
}
 

addParentIssue:

 
This will retrieve the parent issue details for the given issue key:
 
/rest/api/2/issue/{issueKey}?fields=parent
 
Example:
 
Returns:
{
  "expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations",
  "id": "10502",
  "key": "TO-2",
  "fields": {
    "parent": {
      "id": "10000",
      "key": "TO-1",
      "fields": {
        "summary": "test",
        "status": {
          "description": "",
          "iconUrl": "https://{JIRA_BASE_URL}/",
          "name": "To Do",
          "id": "10000",
          "statusCategory": {
            "id": 2,
            "key": "new",
            "colorName": "blue-gray",
            "name": "To Do"
          }
        },
        "priority": {
          "name": "Medium",
          "id": "3"
        },
        "issuetype": {
          "id": "10100",
          "description": "A user story. Created by JIRA Software - do not edit or delete.",
          "name": "Story",
          "subtask": false,
          "avatarId": 10315
        }
      }
    }
  }
}
 

format=excel 

We have decided to deprecate the format=excel feature as this is not highly used, as a workaround you can export to excel in the Report view.
 

 

Was this article helpful?
0 out of 0 found this helpful

Comments

Article is closed for comments.