API for Administering Jira/JSM

[Rita Nygren]

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]

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]

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]

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.

[Sunny Ape]

Hello @Rita Nygren 

What else?

What else.

Hmmm, well the Jira Cloud REST API provides endpoints to manage or interact with:

• Announcement banner
• App data policies
• App migration
• App properties
• Application roles
• Audit records
• Avatars
• Classification levels
• Dashboards
• Dynamic modules
• Field schemes
• Filter sharing
• Filters
• Group and user picker
• Groups
• Issue attachments
• Issue bulk operations
• Issue comment properties
• Issue comments
• Issue custom field associations
• Issue custom field configuration (apps)
• Issue custom field contexts
• Issue custom field options
• Issue custom field options (apps)
• Issue custom field values (apps)
• Issue field configurations
• Issue fields
• Issue link types
• Issue links
• Issue navigator settings
• Issue notification schemes
• Issue priorities
• Issue properties
• Issue redaction
• Issue remote links
• Issue resolutions
• Issue search
• Issue security level
• Issue security schemes
• Issue type properties
• Issue type schemes
• Issue type screen schemes
• Issue types
• Issue votes
• Issue watchers
• Issue worklog properties
• Issue worklogs
• Issues
• JQL
• JQL functions (apps)
• Jira expressions
• Jira settings
• Labels
• License metrics
• Migration of Connect modules to Forge
• Myself
• Permission schemes
• Permissions
• Plans
• Priority schemes
• Project avatars
• Project categories
• Project classification levels
• Project components
• Project email
• Project features
• Project key and name validation
• Project permission schemes
• Project properties
• Project role actors
• Project roles
• Project templates
• Project types
• Project versions
• Projects
• Screen schemes
• Screen tab fields
• Screen tabs
• Screens
• Server info
• Service Registry
• Status
• Tasks
• Teams in plan
• Time tracking
• UI modifications (apps)
• User properties
• User search
• Users
• Webhooks
• Workflow scheme drafts
• Workflow scheme project associations
• Workflow schemes
• Workflow status categories
• Workflow statuses
• Workflow transition properties
• Workflow transition rules
• Workflows

… and other operations.

And that's just for Jira!

Just wait until you read the Jira Service Management REST API documentation yourself to find out for yourself all that you can do with it!!

[Mohamed Benziane]

You can use the api to get all unused scheme (permission scheme, screen scheme, workflow scheme ...).

use the api to identify which user was not connected since X month.

you could also use the api in power bi to generate some report.

and yes you can use the api to get custom field that ate not associated to project and also check if you have some context tie to deleted project.