Connectors Reference
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: Production |
Tier: Premium |
Version: 1.0.0 |
|
Name |
Summary |
|
Create a new issue |
|
|
CreateIssueV2 (string projectKey, string issueTypeIds, [Optional]CreateIssueV2ParameterItem item) |
Create a new issue (V2) |
|
Get issue by key |
|
|
Update issue |
|
|
Add comment |
|
|
Get issue types |
|
|
ListIssueTypesFields (string projectKey, string issuetypeIds) |
Get issue types fields |
|
Get projects |
|
|
Create a new project |
|
|
Get projects |
|
|
Get statuses |
|
|
List users by project |
|
|
Get assignable Users |
|
|
Get priority types |
|
Name |
Summary |
|
When a new issue is created |
|
|
When an issue is closed |
|
|
When an issue is updated |
|
|
When a new issue is returned by a JQL query |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Issue |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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 |
|
|
body |
|
|
True |
Returns:
Type:CreateIssueResponse
Summary: Create a new issue (V2)
Description: This operation is used to create a new issue.
Syntax:
JIRA.CreateIssueV2 (string projectKey, string issueTypeIds, [Optional]CreateIssueV2ParameterItem item)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
projectKey |
string (Project) |
Pick a project to create the issue in. |
True |
|
|
issueTypeIds |
string (Issue Type Id) |
Pick an issue type. |
True |
|
|
item |
|
|
False |
Returns:
Type:CreateIssueResponse
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
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 |
|
|
True |
Returns:
Type:string
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 |
|
|
True |
Returns:
Type:CommentResponse
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 |
Returns:
Type:array of (ListIssueTypesResponseItem)
Summary: Get issue types fields
Description: This operation is used to retrieve a list of fields for a specific issue type.
Syntax:
JIRA.ListIssueTypesFields (string projectKey, string issuetypeIds)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
projectKey |
string (Project) |
|
True |
|
|
issuetypeIds |
string (Issue Types) |
|
True |
Returns:
Type:array of (ListIssueTypesResponseItem)
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)
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 |
|
|
True |
Returns:
Summary: Get projects
Description: This operation is used to retrieve a list of projects for your JIRA instance.
Syntax:
JIRA.ListProjects_V2 ()
Returns:
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)
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 |
Returns:
Type:array of (ListProjectUsersResponseItem)
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)
Summary: Get priority types
Description: This operation returns a list of priority types.
Syntax:
JIRA.ListPriorityTypes ()
Returns:
Type:array of (ListPriorityTypesResponseItem)
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 |
Returns:
Type:array of (FullIssue)
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 |
Returns:
Type:array of (FullIssue)
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 |
Returns:
Type:array of (FullIssue)
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 (FullIssue)
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
body |
string Comment |
Body of the comment. |
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 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fields |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
issuetype |
|
|
|
summary |
string Summary |
Brief description of the issue. |
|
components |
string Components |
A system field that is multiple values addressed by 'name' (e.g. Active Directory, Network Switch). |
|
reporter |
|
|
|
description |
string Description |
A detailed description of the issue. |
|
priority |
|
|
|
labels |
string Labels |
Enter a comma separated list of labels |
|
assignee |
|
|
|
parent |
|
|
|
customfield_10119 |
string Epic Name (customfield_10011) |
Epic name is required for epic issue type. This field matches 'customfield_10011' field on JIRA server. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Issue Type Id |
Pick an issue type. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Reporter Id |
Person reporting the issue. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Priority Id |
Pick a priority for the issue. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Assignee Id |
Agent the issue is assigned to. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Parent Issue Id |
Set the parent for a sub-task. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Issue Id |
Unique identifier of the issue. |
|
key |
string Issue Key |
Unique key of the issue. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
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] |
|
leadAccountId |
string Lead Id |
Id of Project lead. |
|
description |
string Description |
Verbose description of the project. |
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. |
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 |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
issuetype |
|
|
|
timespent |
integer(int32) Time Spent |
The time spent on an issue |
|
project |
|
|
|
aggregatetimespent |
integer(int32) Aggregate Time Spent |
The aggregate time spent on sub-tasks. |
|
resolution |
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 |
|
|
|
timeestimate |
integer(int32) Time Estimate |
Time remaining estimated time in seconds. |
|
aggregatetimeoriginalestimate |
integer(int32) Aggregate Time Estimate |
The original sum of all sub-task time estimates in seconds. |
|
assignee |
|
|
|
updated |
string(date-time) Updated Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
status |
|
|
|
timeoriginalestimate |
integer(int32) 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. |
|
components |
array of (ComponentsItem) Components |
A system field that is multiple values addressed by 'name' (e.g. Active Directory, Network Switch). |
|
creator |
|
|
|
reporter |
|
|
|
aggregateprogress |
|
|
|
duedate |
string(date-time) Due Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
progress |
|
|
|
customfield_10119 |
Epic Name (customfield_10011) |
Epic name is required for epic issue type. This field matches 'customfield_10011' field on JIRA server. |
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. |
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. |
Summary: Resolution
Description: Type of resolution the issue has achieved.
Properties:
|
Name |
Type |
Summary |
|
self |
string URL of the issue resolution |
|
|
id |
string ID of the issue resolution |
|
|
description |
string Description of the issue resolution |
|
|
name |
string Name fo the issue resolution |
|
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. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
accountId |
string Assignee Id |
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. |
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 |
|
|
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. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Component Id |
|
|
name |
string Component Name |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
accountId |
string Creator Id |
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. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
accountId |
string Reporter Id |
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. |
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. |
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. |
Summary: Epic Name (customfield_10011)
Description: Epic name is required for epic issue type. This field matches 'customfield_10011' field on JIRA server.
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
|
|
id |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
|
|
id |
string
|
|
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. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
nextPage |
string Next page |
Next page of projects |
|
values |
array of (ListProjectsResponseItem)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
accountId |
string Id |
Id of the project member. |
|
key |
string Key |
Unique key associated with the user. |
|
emailAddress |
string |
Email address of the user. |
|
displayName |
string Display Name |
Full name of the user. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Status Id |
|
|
name |
string Status Name |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
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 |
|
|
|
priority |
|
|
|
labels |
string Labels |
Enter a comma separated list of labels. |
|
assignee |
|
|
|
parent |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Reporter Id |
Person reporting the issue. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Priority Id |
Pick a priority for the issue. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Assignee Id |
Agent the issue is assigned to. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Parent Issue Id |
Set the parent for a sub-task. |