Versions Compared

Key

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

For  For developping and testing, the JIRA REST API Browser is a great help, because you can run the service calls and test the responses using a GUI.

...

.

 

Table of Contents

JIRA REST API Browser

You can find this free add-on here: https://marketplace.atlassian.com/plugins/com.atlassian.labs.rest-api-browser.

...

Some more information can be found here: https://developer.atlassian.com/docs/atlassian-platform-common-components/rest-api-development/developing-a-rest-service-plugin

Patch the JIRA REST API Browser

Note
titleNot needed any longer

Since Version 3.2.x of the Atlassian REST API Browser, the patch below is not longer required.


Note

Atlassian has added hard-coded information on the REST services  that can be displayed via the JIRA REST Browser, so that, contary to the documentation, services of other add-ons are not displayed. This bug udually usually applies when installing the JIRA REST Browser in a non-development environment, if you are using the JIRA REST API Browser as part of the JIRA SDK, it might work correctly (or not). If you do not see the services starting with "icbiz/", the JIRA REST APi API Browser does not work (or icbiz does not work correctly, e.g. because of a version incompatibility with ictime).

...

Code Block
# download plugin (https://marketplace.atlassian.com/plugins/com.atlassian.labs.rest-api-browser): 
# extract files (js) 
 
unzip rest-api-browser-3.0.x.jar  assets/rab/rest-api-browser.min.js assets/rab/services/rest_resources_service.js 
 
# add icbiz in: assets/rab/rest-api-browser.min.js 
var JIRA_PUBLIC_APIS=["^json-rpc/","^api/2","^auth/","^activities/","^icbiz/"] 
 
# add icbiz in: assets/rab/services/rest_resources_service.js 
var JIRA_PUBLIC_APIS = [ 
                '^json-rpc/', 
                '^api/2', 
                '^auth/', 
                '^activities/', 
                '^icbiz/' 
            ]; 
 
 
# update Jar-file
jar -uf rest-api-browser-3.0.x.jar assets/rab/rest-api-browser.min.js assets/rab/services/rest_resources_service.js 

...

This patched version should also display the services starting with icbiz/.

Example (Work Log Report, /rest/icbiz/1.0/worklog/report)

Go to the respective service and populate the mask with the criteria you want to filter your report (see /icbiz/1.0/worklog/report). In our example, we want to get all work logs for

...