Download as KEY, PPTX
![REST URI Structure
http://host:port/context/rest/api-name/api-version/resource-name
http://example.com:8080/jira/rest/api/2/issue [POST]](https://image.slidesharecdn.com/pdev02abhinavkeswanifinal-120615180742-phpapp02/85/Extend-Your-Use-of-JIRA-by-Solving-Your-Unique-Concerns-An-Expose-of-the-New-JIRA-5-REST-API-21-320.jpg)
![REST URI Structure
http://host:port/context/rest/api-name/api-version/resource-name
http://example.com:8080/jira/rest/api/2/issue [POST]
http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey} [GET, DELETE, PUT]](https://image.slidesharecdn.com/pdev02abhinavkeswanifinal-120615180742-phpapp02/85/Extend-Your-Use-of-JIRA-by-Solving-Your-Unique-Concerns-An-Expose-of-the-New-JIRA-5-REST-API-22-320.jpg)
![REST URI Structure
http://host:port/context/rest/api-name/api-version/resource-name
http://example.com:8080/jira/rest/api/2/issue [POST]
http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey} [GET, DELETE, PUT]
http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey}/assignee [PUT]](https://image.slidesharecdn.com/pdev02abhinavkeswanifinal-120615180742-phpapp02/85/Extend-Your-Use-of-JIRA-by-Solving-Your-Unique-Concerns-An-Expose-of-the-New-JIRA-5-REST-API-23-320.jpg)
![REST URI Structure
http://host:port/context/rest/api-name/api-version/resource-name
http://example.com:8080/jira/rest/api/2/issue [POST]
http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey} [GET, DELETE, PUT]
http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey}/assignee [PUT]
http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey}/comments [GET, POST]](https://image.slidesharecdn.com/pdev02abhinavkeswanifinal-120615180742-phpapp02/85/Extend-Your-Use-of-JIRA-by-Solving-Your-Unique-Concerns-An-Expose-of-the-New-JIRA-5-REST-API-24-320.jpg)
![REST URI Structure
http://host:port/context/rest/api-name/api-version/resource-name
http://example.com:8080/jira/rest/api/2/issue [POST]
http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey} [GET, DELETE, PUT]
http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey}/assignee [PUT]
http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey}/comments [GET, POST]
http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey}/comment/{id} [GET, PUT, DELETE]](https://image.slidesharecdn.com/pdev02abhinavkeswanifinal-120615180742-phpapp02/85/Extend-Your-Use-of-JIRA-by-Solving-Your-Unique-Concerns-An-Expose-of-the-New-JIRA-5-REST-API-25-320.jpg)
Uploaded byAtlassian
Extend Your Use of JIRA by Solving Your Unique Concerns: An Exposé of the New JIRA 5 REST API
The document discusses the new Jira 5 REST API, including its structure, authentication methods, and use cases for remote apps. It highlights key concepts such as Representational State Transfer (REST) and entity expansion for efficient resource management. Various resources and integration options are also provided for developers looking to enhance their use of Jira.
More Related Content
Similar to Extend Your Use of JIRA by Solving Your Unique Concerns: An Exposé of the New JIRA 5 REST API
Extend Your Use of JIRA by Solving Your Unique Concerns: An Exposé of the New JIRA 5 REST API
- 2. Extend your useof JIRA. Solve your unique concerns. An exposé of the new JIRA 5 REST API Abhinav Keswani // @wasabhi Principal, Bespoke Solutions // trineo.com.au // @trineoltd
- 3. What lies ahead? •JIRA 5 REST API • Structure, Authentication, and Entity Expansion • Remote Apps: Key concepts. • How to begin? Useful resources. • In the wild: Use cases and examples of web apps.
- 4. REST (an extremely briefoverview)
- 5.
- 6. Representational State Transfer •Client/Server requests/responses are to facilitate the transfer of representations of resources.
- 7. Representational State Transfer •Client/Server requests/responses are to facilitate the transfer of representations of resources. • Resources are sources of specific information with a unique identifier.
- 8. Representational State Transfer •Client/Server requests/responses are to facilitate the transfer of representations of resources. • Resources are sources of specific information with a unique identifier. • Uniform interface; identify/manipulate resources, self descriptive messages, hypermedia used for application state.
- 9. Hearing @wasabhi talkabout the JIRA 5 REST API - a uniform interface for extensive integration. #summit12
- 10. JIRA 5 RESTAPI
- 11.
- 13. ASSIGNEE COMMENT VOTES ISSUE WATCHERS WORKLOG
- 14. ASSIGNEE COMMENT VOTES ISSUE WATCHERS WORKLOG COMPONENTS PROJECT VERSIONS
- 15. ASSIGNEE COMMENT VOTES ISSUE WATCHERS USER WORKLOG COMPONENTS PROJECT VERSIONS
- 16. ASSIGNEE SEARCH COMMENT VOTES ISSUE WATCHERS USER WORKLOG COMPONENTS PROJECT VERSIONS
- 17. ASSIGNEE SEARCH COMMENT VOTES ISSUE FILTER WATCHERS USER WORKLOG COMPONENTS PROJECT VERSIONS
- 18. FIELD ASSIGNEE SEARCH COMMENT VOTES ISSUE FILTER WATCHERS USER WORKLOG COMPONENTS PROJECT VERSIONS
- 19.
- 20.
- 21. REST URI Structure http://host:port/context/rest/api-name/api-version/resource-name http://example.com:8080/jira/rest/api/2/issue [POST]
- 22. REST URI Structure http://host:port/context/rest/api-name/api-version/resource-name http://example.com:8080/jira/rest/api/2/issue [POST] http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey} [GET, DELETE, PUT]
- 23. REST URI Structure http://host:port/context/rest/api-name/api-version/resource-name http://example.com:8080/jira/rest/api/2/issue [POST] http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey} [GET, DELETE, PUT] http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey}/assignee [PUT]
- 24. REST URI Structure http://host:port/context/rest/api-name/api-version/resource-name http://example.com:8080/jira/rest/api/2/issue [POST] http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey} [GET, DELETE, PUT] http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey}/assignee [PUT] http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey}/comments [GET, POST]
- 25. REST URI Structure http://host:port/context/rest/api-name/api-version/resource-name http://example.com:8080/jira/rest/api/2/issue [POST] http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey} [GET, DELETE, PUT] http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey}/assignee [PUT] http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey}/comments [GET, POST] http://example.com:8080/jira/rest/api/2/issue/{issueIdOrKey}/comment/{id} [GET, PUT, DELETE]
- 26. Authentication HTTP BASIC (SSL) OAUTH ...and... HTTP Cookies, Trusted Applications, OS Username & Password
- 27. Response Notation JSON
- 28.
- 29. Your app isthe “Consumer”. JIRA is the “Service Provider”. You must register your app as an “application link”, which can be identified by JIRA using a “consumer key”, and a public key (x509 RSA-SHA1).
- 30. • You requesta token from the service provider. • Do this by presenting a signed request including your consumer key. Consumer. Service Provider Request Grant Request Token Request Token
- 31. • The serviceprovider grants you a request token. • The token does not authorize you yet. • The end user must authenticate with the service provider and authorize access for the consumer. Consumer. Service Provider Direct End User to Obtain Service Provider User Authorization Direct End User To Consumer
- 32. • The enduser authorized Consumer access, and the Consumer was presented with an oauth token. • Use the oauth token to request an access token from the Service Provider. Consumer. Service Provider Request Grant Access Token Access Token Access Protected Resources
- 33.
- 34. Entity Expansion The expandquery parameter allows a comma-separated list of identifiers to expand. The motivation is to save CPU and network traffic.
- 35. Entity Expansion Specify expansionof entities within another entity using dot notation. For example ?expand=starships.warp expands the starships collection and also the warp property on each starship.
- 36.
- 37. Remoteapps Key Concepts ARemote App is a web application that runs outside the Atlassian application, and yet is accessible by it.
- 38. Remoteapps Key Concepts Asa result, no code is executed on the Atlassian application, but instead, content from the Remote App is included in Atlassian application pages or rendering processes.
- 39. Remoteapps Key Concepts Inthe other direction, a Remote App can subscribe to key events via web hooks to enable more complex workflow integrations.
- 40. Remoteapps Key Concepts Communicationto and from the Remote App is secured through OAuth.
- 41. Remoteapps Key Concepts RemoteApps can be written in any application language and deployed on any server, as long as it is reachable from the Atlassian application over web protocols.
- 42. Key Concepts ★ Secure ★ You are in control of ★ form and function ★ performance and scale ★ Bi directional communication yields superb efficient result
- 43. Go learn more... Don Brown: Plugins OnDemand with RemoteApps. ...tomorrow 11:20-12:00
- 44.
- 45. Choose your weapon. •Customise your integration. CLI or Web usage. • JIRA Java REST Client (JRJC) • JIRA Ruby Gem • Python CLI for JIRA • JIRA Issue Collector (JavaScript)
- 46. Go learn more... Ben Speakmon: JIRA REST Client for Python. ...tomorrow 14:50-15:00
- 47. Oodles of greatdocs...
- 48. Quick look atthe Ruby gem.
- 49.
- 50. JIRA on RubyConsole
- 51.
- 52. Thanks @wizzfiz forletting @wasabhi come out to play! #summit12
- 53.
- 54.
Editor's Notes
- #2 \n
- #3 Quick intro to Abhinav. Mention Trineo (nothing OTT).\n
- #4 Quick intro to the talk.\n
- #5 This slide can be used to break up the chapters of your talk - this would be the start to a new chapter\n- OR -\nThis could be used for making a single statement of a few words or a sentence.\n\nYou should choose one or the other, so that there’s a consistent system.\n
- #6 Move fast through this, and illustrate the reason why REST is well loved today.\nAll resources share a uniform interface.\n
- #7 Move fast through this, and illustrate the reason why REST is well loved today.\nAll resources share a uniform interface.\n
- #8 Move fast through this, and illustrate the reason why REST is well loved today.\nAll resources share a uniform interface.\n
- #9 this can be used for key ideas that you want people to tweet\n
- #10 \n
- #11 \n
- #12 Quickly illustrate how the well known data within JIRA can be accessed via the API.\n
- #13 Quickly illustrate how the well known data within JIRA can be accessed via the API.\n
- #14 Quickly illustrate how the well known data within JIRA can be accessed via the API.\n
- #15 Quickly illustrate how the well known data within JIRA can be accessed via the API.\n
- #16 Quickly illustrate how the well known data within JIRA can be accessed via the API.\n
- #17 Quickly illustrate how the well known data within JIRA can be accessed via the API.\n
- #18 Expand on the HTTP verbs as well as illustrate the uniform interface.\n
- #19 Expand on the HTTP verbs as well as illustrate the uniform interface.\n
- #20 Expand on the HTTP verbs as well as illustrate the uniform interface.\n
- #21 Expand on the HTTP verbs as well as illustrate the uniform interface.\n
- #22 Expand on the HTTP verbs as well as illustrate the uniform interface.\n
- #23 Expand on the HTTP verbs as well as illustrate the uniform interface.\n
- #24 Will elaborate on cookies in particular apart from the preferred http-basic and oauth approaches. Will point out the nice Rich Manalang oauth dance examples repo.\n
- #25 Will elaborate on cookies in particular apart from the preferred http-basic and oauth approaches. Will point out the nice Rich Manalang oauth dance examples repo.\n
- #26 \n
- #27 oauth basics - important to cover this\n
- #28 oauth basics - important to cover this\n
- #29 oauth basics - important to cover this\n
- #30 oauth basics - important to cover this\n
- #31 \n
- #32 \n
- #33 \n
- #34 \n
- #35 \n
- #36 \n
- #37 \n
- #38 \n
- #39 \n
- #40 Just meditating on what else I should cover...not sure whether I want to launch into the JIRA REST Browser here, or subsequently in the “useful resources” section. Either way I would like to show JSON representations, some auth patterns.\n
- #41 Just meditating on what else I should cover...not sure whether I want to launch into the JIRA REST Browser here, or subsequently in the “useful resources” section. Either way I would like to show JSON representations, some auth patterns.\n
- #42 \n
- #43 \n
- #44 Just meditating on what else I should cover...not sure whether I want to launch into the JIRA REST Browser here, or subsequently in the “useful resources” section. Either way I would like to show JSON representations, some auth patterns.\n
- #45 Flip over to my browser to show great docs on Atlassian developer site, docs site, and studio for JRJC.\n
- #46 Browse to the Trineo Ruby gem to flick through the README quickly.\n
- #47 \n
- #48 WIP. Not showing code, perhaps will show the console connecting to a locally running instance of JIRA. Follow the README in the Trineo gem repo.\n\n
- #49 WIP. Not showing code, perhaps will show the console connecting to a locally running instance of JIRA. Follow the README in the Trineo gem repo.\n\n
- #50 this can be used for key ideas that you want people to tweet\n
- #51 WIP. Idea is to show adding comments to an existing issue in JIRA using conversational theming (speech bubbles). Here’s one I prepared earlier ...\n
- #52 fin\n