Overview
This document provides recipes for your needs to adminstrate your JIRA instances programmatically. Your comments/contributions are very welcome as they make our Jira/Ruby community a better place for all.
Sample scripts can be found at examples directory of Jira4R projects' source code repository. irb (interactive ruby) can be used to verify the recipes quickly:
Jira4R interacts with JIRA instances via its SOAP interface:
Atlassian's documentation about web service interface
Atlassian's documentation about SOAP interface
In addition, there are these additional ways to access your Jira instance:
All Jira's SOAP APIs are exposed via Jira4R. In addtion, Jira4R exposes these methods:
* getProjectNoScheme( projectKey )
* getProject( projectKey )
* getNotificationScheme( notificationSchemeName )
* getGroup( groupName )
* getGroupRoleByName( projectRoleName )
* createPermissionScheme( name, description )
* getPermissionScheme( permissionSchemeName )
* getNotificationScheme( notificationSchemeName )
* getPermission( permissionName )
* findPermission( allowedPermissions, permissionName )
* fineEntityInPermissionMapping( permissionMapping, entityName )
* setPermissions( permissionScheme, allowedPermissions, entity )
Recipes
- How to get details of a project with project name?
- How to retrieve values of a custom field
- How to add comment
- How to change field value
- How to create a user
- How to add a new user to a group
- How to add a new version
- How to list all projects' keys