API for Administering Jira/JSM

Question

What are the most popular uses for the Atlassian API for administering the tools (as opposed to developing new add ons)?

For instance, I can see wanting to use the API to output a CSV of all projects with their permission scheme & users/groups with roles.

Or identifying which licensed users are not logging in.

I don't know if they API could do it but I'd love to be able to get a list of custom fields that are not associated with any active project (and delete them).

What else?

David Nickell · Answer

You may find this FREE PowerBI I've created useful... it uses the REST Definitions provided by Atlassian to build an Endpoint Report

REST Endpoint Browser

* The version I am sharing has the GET endpoints only
* There are (IMHO) three kinds of data available through REST:* Configuration (projects / spaces, screens, fields, etc)
* Reference Lists (Users, Issue Types)
* Project Data for Reporting (Ticket data, Workogs, Changelogs for metrics)

* Your use cases require a certain amount of programming aptitude.  Many of the calls return paginated results and the keys from one call may give you the details you need for subsequent calls.  (example -- getting worklogs for an issue means getting the issue first - typically).
* I've found using REST for Reporting and Documentation very effective.  You can, for example, get information about your configuration Real Time.  This saves on time needed to create and maintain documentation.
* Using the Other REST Calls for actually updating your configuration is something that needs to be treated with the utmost care.  Only in extremely well tested and very defined use cases would I ever consider making the updates outside of the Atlassian UI.

If I can make this report more useful or you would like to collaborate, let me know.

Thanks

Prachi Bolar · Answer

Hello,

welcome to community :)

you may also refer to https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#about and https://developer.atlassian.com/cloud/admin/organization/rest/intro/#about

Thank You,

Prachi

Deniz Oğuz - Starware · Answer

Hi,

If you don't want to directly interact with API, you can also use our CLI tool. It has high level functions for doing nearly anything you can do with API itself. Please check our blog post that shows how to use the API for cleaning unused schema objects. You can perform a similar automation for custom fields too. It has both Cloud and DC version and you can interact with the API directly from browser too, if you don't want to install any package to your computer.

PS: I work for the vendor for this tool.