Connectors Reference

JIRA

JIRA is a software development tool for agile teams to plan, track, and release world-class software. Connecting JIRA issues to the rest of your tools helps break down barriers and unleash the potential of your team.

 

Status: Preview

Tier: Premium

Version: 1.0.0

 

Actions:

Name

Summary

CreateIssue (string projectKey, CreateIssueRequest body)

Create a new issue

GetIssue (string issueKey)

Get issue by key

UpdateIssue (string issueKey, UpdateIssueRequest body)

Update issue

AddComment (string issueKey, Comment body)

Add comment

ListIssueTypes (string projectKey)

Get issue types

ListProjects ()

Get projects

CreateProject (CreateProjectParameterProject Project)

Create a new project

ListStatuses (string issueType, string projectId)

Get statuses

ListProjectUsers (string projectKey)

List users by project

ListAssignableUsers (string projectKey)

Get assignable Users

ListPriorityTypes ()

Get priority types

 

Triggers:

Name

Summary

OnNewIssue (string projectKey)

When a new issue is created

OnCloseIssue (string projectKey)

When an issue is closed

OnUpdateIssue (string projectKey)

When an issue is updated

OnNewIssueJQL (string jql)

When a new issue is returned by a JQL query

 

Objects:

Name

Summary

Comment

 

CommentResponse

 

CreateIssueRequest

 

CreateIssueResponse

 

CreateProjectParameterProject

 

CreateProjectResponse

 

FullIssue

Issue

ListIssueTypesResponseItem

 

ListPriorityTypesResponseItem

 

ListProjectsResponseItem

 

ListProjectUsersResponseItem

 

ListStatusesResponseItem

 

OnNewIssueResponseItem

 

UpdateIssueRequest

 

 

Actions:

CreateIssue

Summary: Create a new issue

Description: This operation is used to create a new issue.

 

Syntax:

JIRA.CreateIssue (string projectKey, CreateIssueRequest body)

 

Parameters:

Name

Type

Summary

Required

Related Action

projectKey

string

(Project)

Pick a project to create the issue in.

True

ListProjects

body

CreateIssueRequest

 

 

True

 

Returns:

          Type:CreateIssueResponse

 

GetIssue

Summary: Get issue by key

Description: This operation is used to retrieve the issue object for a given issue Key.

 

Syntax:

JIRA.GetIssue (string issueKey)

 

Parameters:

Name

Type

Summary

Required

Related Action

issueKey

string

(Issue Key)

Unique Key of the issue.

True

 

Returns:

          Type:FullIssue

          Summary: Issue

 

UpdateIssue

Summary: Update issue

Description: This operation is used to update an existing JIRA issue.

 

Syntax:

JIRA.UpdateIssue (string issueKey, UpdateIssueRequest body)

 

Parameters:

Name

Type

Summary

Required

Related Action

issueKey

string

(Issue Key)

Unique Key of the issue.

True

body

UpdateIssueRequest

 

 

True

 

Returns:

          Type:string

 

AddComment

Summary: Add comment

Description: This operation is used to add a comment to an existing JIRA issue.

 

Syntax:

JIRA.AddComment (string issueKey, Comment body)

 

Parameters:

Name

Type

Summary

Required

Related Action

issueKey

string

(Issue Key)

Unique Key of the issue to add a comment to.

True

body

Comment

 

 

True

 

Returns:

          Type:CommentResponse

 

ListIssueTypes

Summary: Get issue types

Description: This operation is used to retrieve a list of issue types for a given project.

 

Syntax:

JIRA.ListIssueTypes (string projectKey)

 

Parameters:

Name

Type

Summary

Required

Related Action

projectKey

string

(Project)

 

True

ListProjects

 

Returns:

          Type:array of (ListIssueTypesResponseItem)

 

ListProjects

Summary: Get projects

Description: This operation is used to retrieve a list of projects for your JIRA instance.

 

Syntax:

JIRA.ListProjects ()

 

Returns:

          Type:array of (ListProjectsResponseItem)

 

CreateProject

Summary: Create a new project

Description: This operation is used to create a new JIRA project.

 

Syntax:

JIRA.CreateProject (CreateProjectParameterProject Project)

 

Parameters:

Name

Type

Summary

Required

Related Action

Project

CreateProjectParameterProject

 

 

True

 

Returns:

          Type:CreateProjectResponse

 

ListStatuses

Summary: Get statuses

Description: This operation is used to retrieve a list of statuses for a project and issue type.

 

Syntax:

JIRA.ListStatuses (string issueType, string projectId)

 

Parameters:

Name

Type

Summary

Required

Related Action

issueType

string

 

 

True

projectId

string

 

 

True

 

Returns:

          Type:array of (ListStatusesResponseItem)

 

ListProjectUsers

Summary: List users by project

Description: This operation is used to retrieve a list of all users associated with a project.

 

Syntax:

JIRA.ListProjectUsers (string projectKey)

 

Parameters:

Name

Type

Summary

Required

Related Action

projectKey

string

(Project key)

Unique key of the project.

True

ListProjects

 

Returns:

          Type:array of (ListProjectUsersResponseItem)

 

ListAssignableUsers

Summary: Get assignable Users

Description: This operation returns a list of the users who can be assigned issues for a given project.

 

Syntax:

JIRA.ListAssignableUsers (string projectKey)

 

Parameters:

Name

Type

Summary

Required

Related Action

projectKey

string

(Project Key)

 

True

 

Returns:

          Type:array of (ListProjectUsersResponseItem)

 

ListPriorityTypes

Summary: Get priority types

Description: This operation returns a list of priority types.

 

Syntax:

JIRA.ListPriorityTypes ()

 

Returns:

          Type:array of (ListPriorityTypesResponseItem)

 

Triggers:

Trigger OnNewIssue

Summary: When a new issue is created

Description: This operation triggers when a new issue is added to the given project.

 

Syntax:

JIRA.OnNewIssue (string projectKey)

 

Parameters:

Name

Type

Summary

Required

Related Action

projectKey

string

(Project)

Unique key of the project to look for new issues.

True

ListProjects

 

Returns:

          Type:array of (OnNewIssueResponseItem)

 

Trigger OnCloseIssue

Summary: When an issue is closed

Description: This operation triggers when an existing issue is closed in the given project.

 

Syntax:

JIRA.OnCloseIssue (string projectKey)

 

Parameters:

Name

Type

Summary

Required

Related Action

projectKey

string

(Project)

Unique key of the project to look for new issues.

True

ListProjects

 

Returns:

          Type:array of (OnNewIssueResponseItem)

 

Trigger OnUpdateIssue

Summary: When an issue is updated

Description: This operation triggers when an existing JIRA issue is updated.

 

Syntax:

JIRA.OnUpdateIssue (string projectKey)

 

Parameters:

Name

Type

Summary

Required

Related Action

projectKey

string

(Project)

Unique key of the project to look for updated issues.

True

ListProjects

 

Returns:

          Type:array of (OnNewIssueResponseItem)

 

Trigger OnNewIssueJQL

Summary: When a new issue is returned by a JQL query

Description: This operation triggers when a new issue appears in the latest 100 results of a JQL query.

 

Syntax:

JIRA.OnNewIssueJQL (string jql)

 

Parameters:

Name

Type

Summary

Required

Related Action

jql

string

(JQL Query)

Query to use.

True

 

Returns:

          Type:array of (OnNewIssueResponseItem)

 


 

Comment

Summary:

Description:

 

          Properties:

Name

Type

Summary

body

string

Comment

Body of the comment.


 

CommentResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Comment Id

Unique id of the comment.

body

string

Comment Body

Body of the comment.

created

string(date-time)

Created Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ


 

CreateIssueRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

fields

Fields

 

 

 

Fields

Summary:

Description:

 

          Properties:

Name

Type

Summary

issuetype

Issuetype

 

 

summary

string

Summary

Brief description of the issue.

reporter

Reporter

 

 

description

string

Description

A detailed description of the issue.

priority

Priority

 

 

labels

string

Labels

Enter a comma separated list of labels

assignee

Assignee

 

 

parent

Parent

 

 

customfield_10119

string

Epic Name (epic only)

Required epic name for epic issue type.

 

Issuetype

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Issue Type Id

Pick an issue type.

 

Reporter

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Reporter Username

Username of the person reporting the issue.

 

Priority

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Priority Id

Pick a priority for the issue.

 

Assignee

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Assignee Username

Username of the agent the issue is assigned to.

 

Parent

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Parent Issue Id

Set the parent for a sub-task.

 


 

CreateIssueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Issue Id

Unique identifier of the issue.

key

string

Issue Key

Unique key of the issue.


 

CreateProjectParameterProject

Summary:

Description:

 

          Properties:

Name

Type

Summary

key

string

Project Key

The unique key, starts with a capital letter.

name

string

Name

Title of the project.

projectTypeKey

string

Type

Project type key.  Values: [Software - Scrum software development, Software - Kanban software development, Software - Basic software development, Business - Project management, Business - Task management, Business - Process management]

lead

string

Lead

Username of the project lead.

description

string

Description

Verbose description of the project.


 

CreateProjectResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Project Id

Unique id of the project.

key

string

Project Key

Unique key of the project.


 

FullIssue

Summary: Issue

Description:

 

          Properties:

Name

Type

Summary

id

string

Issue Id

Unique id of the issue.

key

string

Issue Key

Unique key of the issue.

self

string

Issue URL

Browse to the issue using this URL.

fields

Fields

 

 

 

Fields

Summary:

Description:

 

          Properties:

Name

Type

Summary

issuetype

Issuetype

 

 

timespent

string

Time Spent

The time spent on an issue

project

Project

 

 

aggregatetimespent

string

Aggregate Time Spent

The aggregate time spent on sub-tasks.

resolution

string

Resolution

Type of resolution the issue has achieved.

resolutiondate

string(date-time)

Resolution Date

yyyy-MM-ddTHH:mm:ss.fffZ

workratio

integer(int32)

Work Ratio

The percentage of work logged vs the issue estimate.

created

string(date-time)

Created Date

yyyy-MM-ddTHH:mm:ss.fffZ

priority

Priority

 

 

timeestimate

integer(int32)

Time Estimate

Time remaining estimated time in seconds.

aggregatetimeoriginalestimate

string

Aggregate Time Estimate

The original sum of all sub-task time estimates in seconds.

assignee

Assignee

 

 

updated

string(date-time)

Updated Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

status

Status

 

 

timeoriginalestimate

string

Original Time Estimate

The original time estimate in seconds.

description

string

Description

Issue description.

aggregatetimeestimate

integer(int32)

Aggregate Time Estimate

Time sum of all sub-tasks remaining estimated time in seconds.

summary

string

Summary

Title of the issue.

creator

Creator

 

 

reporter

Reporter

 

 

aggregateprogress

Aggregateprogress

 

 

duedate

string(date-time)

Due Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

progress

Progress

 

 

customfield_10119

string

Epic Name (epic only)

Required epic name for epic issue type.

 

Issuetype

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Issue Type Id

Unique id of the issue type.

description

string

Issue Type Description

Verbose title of the issue type.

iconUrl

string

Issue Type Icon URL

Icon associated with the issue type.

name

string

Issue Type Name

Title of the issue type.

 

Project

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Project Id

The unique id of the project.

key

string

Project Key

The unique key of the project.

name

string

Project Name

Title of the project.

projectTypeKey

string

Project Type Key

Unique key of the project type.

 

Priority

Summary:

Description:

 

          Properties:

Name

Type

Summary

iconUrl

string

Priority Icon URL

Icon associated with the issue priority.

name

string

Priority Name

Title of the priority.

id

string

Priority Id

Id of the issue priority.

 

Assignee

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Assignee Name

Username of the person a issue is assigned to.

key

string

Assignee Key

User key of the person issue is assigned to.

emailAddress

string

Assignee Email

Email of the person issue is assigned to.

displayName

string

Assignee Display Name

Display name of the person issue is assigned to.

 

Status

Summary:

Description:

 

          Properties:

Name

Type

Summary

description

string

Status Description

Issue status.

iconUrl

string

Status Icon URL

Issue status.

name

string

Status Name

Issue status.

id

string

Status Id

Issue status.

statusCategory

StatusCategory

 

 

 

StatusCategory

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Status Category Id

Issue status category.

key

string

Status Category Key

Issue status category.

colorName

string

Status Category Color Name

Issue status category.

name

string

Status Category Name

Issue status category.

 

Creator

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Creator Name

Name of the user who created the issue.

key

string

Creator Key

Unique key of the user who created the issue.

emailAddress

string

Creator Email

Email of the user who created the issue.

displayName

string

Creator Display Name

Name of the user who created the issue.

 

Reporter

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Reporter Name

Name of the user who reported the issue.

key

string

Reporter Key

Unique key of the user who reported the issue.

emailAddress

string

Reporter Email

Email of the user who reported the issue.

displayName

string

Reporter Display Name

Display name of the user who reported the issue.

 

Aggregateprogress

Summary:

Description:

 

          Properties:

Name

Type

Summary

progress

integer(int32)

Aggregate Progress Completed

The total progress completed of all sub-tasks in seconds.

total

integer(int32)

Aggregate Estimated Effort

The total sum of all estimated sub-task effort.

percent

integer(int32)

Aggregate Progress Percent

The percent of aggregate completed progress in relation to estimated effort.

 

Progress

Summary:

Description:

 

          Properties:

Name

Type

Summary

progress

integer(int32)

Progress Completed

The progress complete in seconds.

total

integer(int32)

Estimated Effort

The estimated effort.

percent

integer(int32)

Progress Percent

The percent of completed progress in relation to estimated effort.

 


 

ListIssueTypesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

 

id

string

 

 


 

ListPriorityTypesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

 

id

string

 

 


 

ListProjectsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Project Id

The unique Id of the project.

key

string

Project Key

The unique key of the project.

name

string

Project Name

Name of the project.

projectTypeKey

string

Project Type Key

The unique key of the project type.


 

ListProjectUsersResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

Username of the project member.

key

string

Key

Unique key associated with the user.

emailAddress

string

Email

Email address of the user.

displayName

string

 

Full name of the  user.


 

ListStatusesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Status Id

 

name

string

Status Name

 


 

OnNewIssueResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Issue Id

The unique id of the Issue.

key

string

Issue Key

The unique key of the issue.

self

string

Issue URL

Browse to the issue using this URL.

fields

Fields

 

 

 

Fields

Summary:

Description:

 

          Properties:

Name

Type

Summary

issuetype

Issuetype

 

 

timespent

string

Time Spent

The time spent on this issue

project

Project

 

 

aggregatetimespent

string

Aggregate Time Spent

The aggregate time spent on sub-tasks.

resolution

string

Resolution

The resolution stage a project has reached.

resolutiondate

string(date-time)

Resolution Date

yyyy-MM-ddTHH:mm:ss.fffZ

workratio

integer(int32)

Work Ratio

The percentage of work logged vs the issue estimate.

created

string(date-time)

Created Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

priority

Priority

 

 

timeestimate

integer(int32)

Time Estimate

Time remaining estimated time in seconds.

aggregatetimeoriginalestimate

string

Original Aggregate Time Estimate

The original sum of all sub-task time estimates in seconds.

assignee

Assignee

 

 

updated

string(date-time)

Updated Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

status

Status

 

 

timeoriginalestimate

string

Original Time Estimate

The original time estimate in seconds.

description

string

Description

Issue description.

aggregatetimeestimate

integer(int32)

Aggregate Time Estimate

Time sum of all sub-tasks remaining estimated time in seconds.

summary

string

Summary

Brief title of the issue.

creator

Creator

 

 

reporter

Reporter

 

 

aggregateprogress

Aggregateprogress

 

 

duedate

string(date-time)

Due Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

progress

Progress

 

 

customfield_10119

string

Epic Name (epic only)

Required epic name for epic issue type.

 

Issuetype

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Isue Type Id

Unique id of the issue type.

description

string

Issue Type Description

Uniquw description of the issue type.

iconUrl

string

Issue Type Icon URL

URL associated with the issue type.

name

string

Issue Type Name

Title of the issue type.

 

Project

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Project Id

The unique Id of the project.

key

string

Project Key

The unique key of the project.

name

string

Project Name

Title of the project.

projectTypeKey

string

Project Type Key

The unique key of the project type.

 

Priority

Summary:

Description:

 

          Properties:

Name

Type

Summary

iconUrl

string

Priority Icon URL

Icon associated with the priority type.

name

string

Priority Name

Title of the priority type.

id

string

Priority Id

Unique id of the priority type.

 

Assignee

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Assignee Name

User name of the person issue is assigned to.

key

string

Assignee Key

Unique key of the person issue is assigned to.

emailAddress

string

Assignee Email

Email address of the person issue is assigned to.

displayName

string

Assignee Display Name

Display name of the person issue is assigned to.

 

Status

Summary:

Description:

 

          Properties:

Name

Type

Summary

description

string

Status Description

Verbose description of the status type.

iconUrl

string

Status Icon URL

Icon associated with the status type.

name

string

Status Name

Title of the status type.

id

string

Status Id

Unique id of the status type.

statusCategory

StatusCategory

 

 

 

StatusCategory

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Status Category Id

Unique id of the status category.

key

string

Status Category Key

Unique key of the status category.

colorName

string

Status Category Color Name

Color name of the status category.

name

string

Status Category Name

Name of the status category.

 

Creator

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Creator Name

Username of the person who created the issue.

key

string

Creator Key

Unique key of the person who created the issue.

emailAddress

string

Creator Email

Email of the person who created the issue.

displayName

string

Creator Display Name

Display name of the person who created the issue.

 

Reporter

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Reporter Name

Username of the person who reported the issue.

key

string

Reporter Key

Unique key of the person who reported the issue.

emailAddress

string

Reporter Email

Email of the person who reported the issue.

displayName

string

Reporter Display Name

Display name of the person who reported the issue.

 

Aggregateprogress

Summary:

Description:

 

          Properties:

Name

Type

Summary

progress

integer(int32)

Aggregate Progress Completed

The total progress completed of all sub-tasks in seconds.

total

integer(int32)

Aggregate Estimated Effort

The total sum of all estimated sub-task effort.

percent

integer(int32)

Aggregate Progress Percent

The percent of aggregate completed progress in relation to estimated effort.

 

Progress

Summary:

Description:

 

          Properties:

Name

Type

Summary

progress

integer(int32)

Progress Completed

The progress complete in seconds.

total

integer(int32)

Estimated Effort

The estimated effort.

percent

integer(int32)

Progress Percent

The percent of completed progress in relation to estimated effort.

 


 

UpdateIssueRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

fields

Fields

 

 

 

Fields

Summary:

Description:

 

          Properties:

Name

Type

Summary

summary

string

Summary

Brief description of the issue.

description

string

Description

A detailed description of the issue.

reporter

Reporter

 

 

priority

Priority

 

 

labels

string

Labels

Enter a comma separated list of labels.

assignee

Assignee

 

 

parent

Parent

 

 

 

Reporter

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Reporter Username

Username of the person reporting the issue.

 

Priority

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Priority Id

Pick a priority for the issue.

 

Assignee

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Assignee Username

Username of the agent the issue is assigned to.

 

Parent

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Parent Issue Id

Set the parent for a sub-task.