JIRA API Set for PO

[Shaun Roberts]

Type of API

JSON based web services

NOTE: This is still a work in progress API,  however for what I've written, it works for me :)

Base API Structure and Background at https://docs.atlassian.com/jira/REST/latest/

Current Version:  1.0.1.1
Required Version of CPO: 3.0.2
Release date: 08-07-2014
NOTE: The attached automation pack is zipped. Please unzip and then import into PO. Requires the target type class pack.
Developer: Shaun Roberts, 2013-2014

You can find information on the target type class pack @ https://supportforums.cisco.com/document/11938656/customersupportcasetargettypes-10-11-2013-1-0-0-2zip
 

---

Changelog

• 1.0.1.1- Initial release set to work with CPO 3.0.2+

---

Function List

GetIssues-  Gets a listing of issues

 Inputs: 

Input.Jira.JQL - select statement to grab issues with. Example: "project=BUG"
Input.Jira.Max.Results - max results to return from query

Input.Jira.Start.At - index to start at

Returns:

Output.Jira.XML - XML output of the webcall. 

             Output.Jira.JSON - base JSON output of webcall

. 
 

---

GetSingleAttachment -  Returns a single attachment from a Jira Issue

 Inputs: 

Input.Jira.Attachment.Id - id of attachment
 

 Returns:

Output.Jira.XML - XML output of the webcall. 

             Output.Jira.JSON - base JSON output of webcall

Output.Jira.JSON - base JSON output of webcall
 

---

CreateSearchJob -  Creates a new search job

 Inputs: 

Input.Max.Count - max count to return to search
Input.Search.Id - search ID to be defined if you do not want a system generated search id
Input.Search.String - search string for splunk - function will escape chracters for you
 

 Returns:

Output.Search.Id - search id that is produced from this web call
 

---

GetSingleComment -  returns a single comment

 Inputs: 

Input.Comment.ID - id of single comment

 

 Returns:

Output.Jira.XML - XML output of the webcall. 

            Output.Jira.JSON - base JSON output of webcall

---

GetSingleIssue - returns data on a single jira issue

 Inputs: 

Input.Jira.Issue.Key - key of single issue. ie "BUG-5555"
 

 Returns:

Output.Jira.XML - XML output of the webcall. 

             Output.Jira.JSON - base JSON output of webcall

---

GetStatusBasedOnId - returns status of a jira issue based on ID

 Inputs: 

Input.Jira.Status.Number - status number
 

 Returns:

Output.Jira.XML - XML output of the webcall. 

            Output.Jira.JSON - base JSON output of webcall

            Output.Status - status returned from call

. 
 

---

HELPER FUNCTION: Convert Comments XML to Table

This function runs on an already created JIRA ISSUE target type. It takes in comments that are brought in via XML when you use the Get Single Issue method. it then converts the comments XML to a table format and stores that table of comments on the JIRA ISSUE target.

 Inputs: 

Input.Comments.Xml - comments pulled from a bug in XML form.

 Returns:

NONE