Overview
Configuration is provided for establishing connections with the JIRA service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to Jira REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From the drop-down menu Configuration select Jira. Set [domain] to the desired domain in the Server host parameter. Then click New in the Token File parameter to create a new token file.
Step 3. Click on the Next button in the next wizard to continue with the token generation process.
Step 4: Enter your Email in the next wizard. Then press the 'Continue' button.
Step 5: Enter your Password and then press the 'Log in' button.
Step 6: In the next wizard click on the Accept button to retrieve the access_token.
Step 7: Save the generated access token to the file. Specify token protection password. Click OK.
Step 8. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Jira instance using OAUTH 2.0.
Note: Recommended Authentication type is OAUTH 2.0
In this guide, we will show how to read data from the Jira service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double-click on the "REST Source" component and select Jira connection from the combo. Select from available JIra resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select the Jira resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from the Jira service.
In this guide, we will show how to write data to the Jira service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double-click on the "REST Destination" component and select Jira connection from the combo. Also, select the resource action and Jira resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Jira resource.
Configuration
Base URL address: https://[domain].atlassian.net/rest/api/latest.
- Basic
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Name: Required. Specify user name.
- Password: Required. Specify password.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Basic {{=Base64.encode(connection.user.Name + ':' + connection.user.Password)}}
Documentation: https://developer.atlassian.com/cloud/jira/platform/jira-rest-api-basic-authentication/.
- OAuth
-
The authentication uses an authorized token.
The authentication has the following user-defined parameters:
- ConsumerKey: Required. Specify consumer key.
- Certificate: Required. Select certificate file (pfx).
- Password: Required. Specify certificate password.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
OAuth {{=Jira.getAuthentication(token, request)}}
Documentation: https://developer.atlassian.com/cloud/jira/platform/jira-rest-api-oauth-authentication/.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/permissions.
The result is extracted from:{{=response.permissions}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2-getAllPermissions.
- key
Template: ShortText.
- name
Template: ShortText.
- type
Template: ShortText.
- description
Template: LongText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/applicationrole.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/applicationrole-getAll.
- key
Template: ShortText.
- groups
Template: LongText. A composite field.
- name
Template: ShortText.
- defaultGroups
Template: LongText. A composite field.
- selectedByDefault
Data type: DT_BOOL
- defined
Data type: DT_BOOL
- numberOfSeats
Data type: DT_I4
- remainingSeats
Data type: DT_I4
- userCount
Data type: DT_I4
- userCountDescription
Template: ShortText.
- hasUnlimitedSeats
Data type: DT_BOOL
- platform
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/auditing/record.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/auditing-getRecords.
-
offset:
- id
A key field. Data type: DT_I4
- summary
Template: ShortText.
- remoteAddress
Template: ShortText.
- authorKey
Template: ShortText.
- created
Template: DateTime.
- category
Template: ShortText.
- eventSource
Template: ShortText.
- description
Template: LongText.
- objectItem
Template: AssociatedItem.
- changedValues
Field components:
- An array.
- Contains the following components: fieldName, changedFrom, changedTo.
- associatedItems
Field components:
- An array.
-
Uses template:
AssociatedItem.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/avatar/{{=parameters.type}}/system.
The result is extracted from:{{=response.system}}.The action has the following user-defined parameters:
- type: Required. Specify type.
Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/avatar-getAllSystemAvatars.
- id
A key field. Data type: DT_I4
- owner
Template: ShortText.
- isSystemAvatar
Data type: DT_BOOL
- isSelected
Data type: DT_BOOL
- isDeletable
Data type: DT_BOOL
- urls
Template: UrlsT.
- selected
Data type: DT_BOOL
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/component.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/component-createComponent.
- [Update] action
-
Endpoint URL address:
/component/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/component-updateComponent.
- [Delete] action
-
Endpoint URL address:
/component/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/component-delete.
The resource includes the fields from the ComponentT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/dashboard.
The result is extracted from:{{=response.dashboards}}.The following request parameters will be automatically processed:
-
startAt:
{{=parameters.iterator}} -
maxResults:
{{=parameters.batchSize}}
Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/dashboard-list.
-
startAt:
- id
Template: ShortText.
- self
Template: ShortText.
- name
Template: ShortText.
- view
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/field.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/field-getFields.
- [Create] action
-
Endpoint URL address:
/field.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/field-createCustomField.
The resource includes the fields from the FieldT template.
- type
Template: ShortText.
- searcherKey
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/field/{{=parameters.fieldKey}}/option.
The result is extracted from:{{=response.values}}.The action has the following user-defined parameters:
- fieldKey: Required. Specify field key.
The following request parameters will be automatically processed:
-
startAt:
{{=parameters.iterator}} -
maxResults:
{{=parameters.batchSize}}
Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/field/{fieldKey}/option-getAllOptions.
- [Create] action
-
Endpoint URL address:
/field/{{=item.fieldKey}}/option.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/field/{fieldKey}/option-createOption.
- [Update] action
-
Endpoint URL address:
/field/{{=item.fieldKey}}/option/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/field/{fieldKey}/option-putOption.
- [Delete] action
-
Endpoint URL address:
/field/{{=item.fieldKey}}/option/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/field/{fieldKey}/option-delete.
- id
A key field. Data type: DT_I4
- value
Template: ShortText.
- properties
Template: LongText. A composite field.
- config
Field components:
-
Uses template:
LongText. - Contains the following components: scope, attributes.
-
Uses template:
- fieldKey
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/filter.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/filter-getFilters.
- [Read favourite] action
-
Endpoint URL address:
/filter/favourite.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/filter-getFavouriteFilters.
- [Read my] action
-
Endpoint URL address:
/filter/my.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/filter-getMyFilters.
- [Create] action
-
Endpoint URL address:
/filter.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/filter-createFilter.
- [Update] action
-
Endpoint URL address:
/filter/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/filter-editFilter.
- [Delete] action
-
Endpoint URL address:
/filter/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/filter-deleteFilter.
- id
A key field. Template: ShortText.
- self
Template: ShortText. A read-only field.
- name
Template: ShortText.
- description
Template: LongText.
- owner
Template: User. A read-only field.
- jql
Template: ShortText.
- viewUrl
Template: ShortText. A read-only field.
- searchUrl
Template: ShortText. A read-only field.
- favourite
Data type: DT_BOOL
- favouritedCount
Data type: DT_I4
- sharePermissions
A read-only field. The value is gathered from
/filter/{{=item.id}}/permissionaddress. Field components:- An array.
-
Uses template:
FilterPermission.
- sharedUsers
A read-only field. Field components:
- Contains the following components: size, max-results, start-index, end-index, items.
- subscriptions
A read-only field. Field components:
- Contains the following components: size, max-results, start-index, end-index, items.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/filter/{{=parameters.filterId}}/permission.
The result is extracted from:{{=.The action has the following user-defined parameters:
- filterId: Required. Specify filter identifier.
Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/filter-getSharePermissions.
- [Create] action
-
Endpoint URL address:
/filter/{{=item.filterId}}/permission.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/filter-addSharePermission.
- [Delete] action
-
Endpoint URL address:
/filter/{{=item.filterId}/permission/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/filter-deleteSharePermission.
The resource includes the fields from the FilterPermission template.
- filterId
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groups/picker.
The result is extracted from:{{=response.groups}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/groups-findGroups.
- [Create] action
-
Endpoint URL address:
/group.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/group-createGroup.
- [Delete] action
-
Endpoint URL address:
/group/{{=item.name}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/group-removeGroup.
- name
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/group/member.
The result is extracted from:{{=response.values}}.The action has the following user-defined parameters:
- groupname: Required. Specify group name.
The following request parameters will be automatically processed:
-
startAt:
{{=parameters.iterator}} -
maxResults:
{{=parameters.batchSize}}
Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/group-getUsersFromGroup.
- [Create] action
-
Endpoint URL address:
/group/user.The following request parameters will be automatically processed:
-
groupname:
{{=item.groupname}}
Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/group-addUserToGroup.
-
groupname:
- [Delete] action
-
Endpoint URL address:
/group/user.The following request parameters will be automatically processed:
-
groupname:
{{=item.groupname}} -
username:
{{=item.name}}
Documentation: https://docs.atlassian.com/jira/REST/cloud/#api/2/group-removeUserFromGroup.
-
groupname:
The resource includes the fields from the User template.
- groupname
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groupuserpicker.
The result is extracted from:{{=response.users}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.219065497.1846900114.1499590340-1822901900.1499590340#api/2/groupuserpicker-findUsersAndGroups.
The resource includes the fields from the User template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/search.
The result is extracted from:{{=response.issues}}.
The action uses POST method.The action has the following user-defined parameters:
- jql: Required. Specify JQL query string.
- expand: Specify comma-separated (,) list of additional information to include. Optional.
The following request parameters will be automatically processed:
-
application/json:
{{=_.extend({ startAt: parameters.iterator, maxResults: parameters.batchSize, expand: parameters.get('expand') && JSON.parse(parameters.expand) }, parameters)}}
Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.39728103.575841309.1499356570-1015751676.1499356570#api/2/search-search.
- [Create] action
-
Endpoint URL address:
/issue/bulk.
The result is extracted from:{{=response.issues}}.The following request parameters will be automatically processed:
-
application/json:
{{={ issueUpdates: batch } }}
Documentation: https://docs.atlassian.com/jira/REST/cloud/?&_ga=2.134749365.575841309.1499356570-1015751676.1499356570#api/2/issue-createIssues.
-
application/json:
- [Update] action
-
Endpoint URL address:
/issue/{{=item.id || item.key}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.205338896.1276531472.1499511116-821715029.1499511116#api/2/issue-editIssue.
- [Delete] action
-
Endpoint URL address:
/issue/{{=item.id || item.key}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.5149363.1276531472.1499511116-821715029.1499511116#api/2/issue-deleteIssue.
- id
A key field. Template: ShortText.
- self
Template: ShortText. A read-only field.
- key
A key field. Template: ShortText.
- expand
Template: ShortText. A read-only field.
- transitions
A read-only field. The value is gathered from
/issue/{{=item.id}}/transitionsaddress. Field components:- An array.
-
Uses template:
TransitionT.
- operations
A read-only field. Field components:
- Contains the following components: linkGroups.
- editmeta
A read-only field. The value is gathered from
/issue/{{=item.id}}/editmetaaddress. Field components:- Contains the following components: fields.
- changelog
A read-only field. The value is gathered from
/issue/{{=item.id}}/changelogaddress. The gathered value is processed with{{=response.values}}expression. Field components:- Contains the following components: startAt, maxResults, total, histories.
- versionedRepresentations
Template: LongText. A read-only field. A composite field.
- fieldsToInclude
Template: LongText. A read-only field. A composite field.
- remoteLink
A read-only field. The value is gathered from
/issue/{{=item.id}}/remotelinkaddress. Field components:- An array.
-
Uses template:
RemoteLinkT.
- voters
A read-only field. The value is gathered from
/issue/{{=item.id}}/votesaddress. Field components:- An array.
-
Uses template:
User.
- watchers
A read-only field. The value is gathered from
/issue/{{=item.id}}/watchersaddress. Field components:- An array.
-
Uses template:
User.
- comments
A read-only field. The value is gathered from
/issue/{{=item.id}}/commentaddress. Field components:- An array.
-
Uses template:
Comment.
- worklogs
A read-only field. The value is gathered from
/issue/{{=item.id}}/worklogaddress. Field components:- An array.
-
Uses template:
Worklog.
- transition
Template: TransitionT.
- update
Template: LongText. A composite field.
- historyMetadata
Template: HistoryMetadataT.
- properties
Template: LongText. A composite field.
- [External]
-
The external fields URL address:
/field.- fields.{{=external.id}}
Template: {{=Jira.getFieldTemplate(external.schema)}}. Data type: DT_WSTR ( length 1000 )
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/issue/{{=parameters.issueIdOrKey}}/remotelink.The action has the following user-defined parameters:
- issueIdOrKey: Required. Specify issue identifier or key.
Documentation: https://docs.atlassian.com/jira/REST/cloud/?&_ga=2.17134009.1276531472.1499511116-821715029.1499511116#api/2/issue-getRemoteIssueLinks.
- [Create] action
-
Endpoint URL address:
/issue/{{=item.issueIdOrKey}}/remotelink.
- [Update] action
-
Endpoint URL address:
/issue/{{=item.issueIdOrKey}}/remotelink/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.105338371.1276531472.1499511116-821715029.1499511116#api/2/issue-updateRemoteIssueLink.
- [Delete] action
-
Endpoint URL address:
/issue/{{=item.issueIdOrKey}}/remotelink/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/?&_ga=2.8854069.1276531472.1499511116-821715029.1499511116#api/2/issue-deleteRemoteIssueLinkById.
The resource includes the fields from the RemoteLinkT template.
- issueIdOrKey
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/issue/{{=parameters.issueIdOrKey}}/comment.
The result is extracted from:{{=response.comments}}.The action has the following user-defined parameters:
- issueIdOrKey: Required. Specify issue identifier or key.
The following request parameters will be automatically processed:
-
startAt:
{{=parameters.iterator}} -
maxResults:
{{=parameters.batchSize}}
- [Create] action
-
Endpoint URL address:
/issue/{{=item.issueIdOrKey}}/comment.
- [Update] action
-
Endpoint URL address:
/issue/{{=item.issueIdOrKey}}/comment/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/issue/{{=item.issueIdOrKey}}/comment/{{=item.id}}.
The resource includes the fields from the Comment template.
- issueIdOrKey
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/issue/{{=parameters.issueIdOrKey}}/worklog.
The result is extracted from:{{=response.worklogs}}.The action has the following user-defined parameters:
- issueIdOrKey: Required. Specify issue identifier or key.
The following request parameters will be automatically processed:
-
startAt:
{{=parameters.iterator}} -
maxResults:
{{=parameters.batchSize}}
- [Create] action
-
Endpoint URL address:
/issue/{{=item.issueIdOrKey}}/worklog.
- [Update] action
-
Endpoint URL address:
/issue/{{=item.issueIdOrKey}}/worklog/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/issue/{{=item.issueIdOrKey}}/worklog/{{=item.id}}.
The resource includes the fields from the Worklog template.
- issueIdOrKey
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/issueLinkType.
The result is extracted from:{{=response.issueLinkTypes}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/?&_ga=2.106200451.1276531472.1499511116-821715029.1499511116#api/2/issueLinkType-getIssueLinkTypes.
- [Create] action
-
Endpoint URL address:
/issueLinkType.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.14636343.1276531472.1499511116-821715029.1499511116#api/2/issueLinkType-createIssueLinkType.
- [Update] action
-
Endpoint URL address:
/issueLinkType/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.5594675.1276531472.1499511116-821715029.1499511116#api/2/issueLinkType-updateIssueLinkType.
- [Delete] action
-
Endpoint URL address:
/issueLinkType/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.5594675.1276531472.1499511116-821715029.1499511116#api/2/issueLinkType-deleteIssueLinkType.
The resource includes the fields from the IssueLinkType template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/issuesecurityschemes.
The result is extracted from:{{=response.issueSecuritySchemes}}.
- id
A key field. Data type: DT_I4
- self
Template: ShortText.
- name
Template: ShortText.
- description
Template: LongText.
- defaultSecurityLevelId
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/issuetype.Documentation: https://docs.atlassian.com/jira/REST/cloud/?&_ga=2.51197353.1276531472.1499511116-821715029.1499511116#api/2/issuetype-getIssueAllTypes.
- [Read alternative] action
-
Endpoint URL address:
/issuetype/{{=parameters.alternative}}/alternatives.The action has the following user-defined parameters:
- alternative: Required. Specify issue type.
- [Create] action
-
Endpoint URL address:
/issuetype.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.13448631.1276531472.1499511116-821715029.1499511116#api/2/issuetype-createIssueType.
- [Update] action
-
Endpoint URL address:
/issuetype/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.109977093.1276531472.1499511116-821715029.1499511116#api/2/issuetype-updateIssueType.
- [Delete] action
-
Endpoint URL address:
/issuetype/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.50665769.1276531472.1499511116-821715029.1499511116#api/2/issuetype-deleteIssueType.
The resource includes the fields from the IssueType template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/notificationscheme.
The result is extracted from:{{=response.values}}.The following request parameters will be automatically processed:
-
startAt:
{{=parameters.iterator}} -
maxResults:
{{=parameters.batchSize}}
-
startAt:
The resource includes the fields from the NotificationSchemeT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/permissionscheme.
The result is extracted from:{{=response.permissionSchemes}}.
- [Create] action
-
Endpoint URL address:
/permissionscheme.
- [Update] action
-
Endpoint URL address:
/permissionscheme/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/permissionscheme/{{=item.id}}.
The resource includes the fields from the PermissionSchemeT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/permissionscheme/{{=parameters.schemeId}}/permission.
The result is extracted from:{{=response.permissions}}.The action has the following user-defined parameters:
- schemeId: Required. Specify permission scheme identifier.
- [Create] action
-
Endpoint URL address:
/permissionscheme/{{=item.schemeId}}/permission.
- [Delete] action
-
Endpoint URL address:
/permissionscheme/{{=item.schemeId}}/permission/{{=item.id}}.
The resource includes the fields from the SchemePermission template.
- schemeId
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/priority.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.256880011.1846900114.1499590340-1822901900.1499590340#api/2/priority-getPriorities.
The resource includes the fields from the PriorityT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/project.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.256214283.1846900114.1499590340-1822901900.1499590340#api/2/project-getAllProjects.
- [Create] action
-
Endpoint URL address:
/project.Documentation: https://docs.atlassian.com/jira/REST/cloud/?&_ga=2.222619931.1846900114.1499590340-1822901900.1499590340#api/2/project-createProject.
- [Update] action
-
Endpoint URL address:
/project/{{=item.id || item.key}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.259368202.1846900114.1499590340-1822901900.1499590340#api/2/project-updateProject.
- [Delete] action
-
Endpoint URL address:
/project/{{=item.id || item.key}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/?&_ga=2.259368202.1846900114.1499590340-1822901900.1499590340#api/2/project-deleteProject.
The resource includes the fields from the ProjectT template.
- components
A read-only field. The value is gathered from
/project/{{=valueParent.id}}/componentsaddress. Field components:- An array.
-
Uses template:
ComponentT.
- issueTypes
A read-only field. The value is gathered from
/project/{{=valueParent.id}}/statusesaddress. Field components:- An array.
-
Uses template:
IssueType.
- versions
A read-only field. The value is gathered from
/project/{{=valueParent.id}}/versionsaddress. Field components:- An array.
-
Uses template:
VersionT.
- roles
The value is gathered from
/project/{{=valueParent.id}}/roleaddress. The gathered value is processed with{{=_.map(response, function (v, k) { return { key: k, url: v }; })}}expression. Field components:- An array.
- Contains the following components: key, url.
- issueSecurityScheme
The value is gathered from
/project/{{=valueParent.id}}/issuesecuritylevelschemeaddress. Field components:-
Uses template:
ShortText. - Contains the following components: id, self, name, description, defaultSecurityLevelId, levels.
-
Uses template:
- permissionScheme
Template: PermissionSchemeT. The value is gathered from
/project/{{=valueParent.id}}/permissionschemeaddress.- notificationScheme
Template: NotificationSchemeT. The value is gathered from
/project/{{=valueParent.id}}/notificationschemeaddress.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/project/type.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.260056589.1846900114.1499590340-1822901900.1499590340#api/2/project/type-getAllProjectTypes.
- key
Template: ShortText.
- formattedKey
Template: ShortText.
- descriptionI18nKey
Template: LongText.
- icon
Data type: DT_IMAGE
- color
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/projectCategory.
- [Create] action
-
Endpoint URL address:
/projectCategory.
- [Update] action
-
Endpoint URL address:
/projectCategory/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/projectCategory/{{=item.id}}.
- id
A key field. Template: ShortText.
- self
Template: ShortText. A read-only field.
- name
Template: ShortText.
- description
Template: LongText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/resolution.Documentation: https://docs.atlassian.com/jira/REST/cloud/?&_ga=2.13470391.1846900114.1499590340-1822901900.1499590340#api/2/resolution-getResolutions.
The resource includes the fields from the ResolutionT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/role.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.256870923.1846900114.1499590340-1822901900.1499590340#api/2/role-getProjectRoles.
- [Create] action
-
Endpoint URL address:
/role.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.12970551.1846900114.1499590340-1822901900.1499590340#api/2/role-createProjectRole.
- [Update] action
-
Endpoint URL address:
/role/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.45449508.1846900114.1499590340-1822901900.1499590340#api/2/role-fullyUpdateProjectRole.
- [Delete] action
-
Endpoint URL address:
/role/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.45449508.1846900114.1499590340-1822901900.1499590340#api/2/role-deleteProjectRole.
The resource includes the fields from the RoleT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/status.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.259295754.1846900114.1499590340-1822901900.1499590340#api/2/status-getStatuses.
The resource includes the fields from the StatusT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/statuscategory.
The resource includes the fields from the StatusCategoryT template.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/version.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.20315704.1846900114.1499590340-1822901900.1499590340#api/2/version-createVersion.
- [Update] action
-
Endpoint URL address:
/version/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.223322523.1846900114.1499590340-1822901900.1499590340#api/2/version-updateVersion.
- [Delete] action
-
Endpoint URL address:
/version/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.260369549.1846900114.1499590340-1822901900.1499590340#api/2/version-delete.
The resource includes the fields from the VersionT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/workflow.
The result is extracted from:.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.255648904.1846900114.1499590340-1822901900.1499590340#api/2/workflow-getAllWorkflows.
- name
Template: ShortText.
- description
Template: LongText.
- lastModifiedDate
Template: DateTime.
- lastModifiedUser
Template: ShortText.
- steps
Data type: DT_I4
- isDefault
Data type: DT_BOOL
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/workflowscheme.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.54308264.1846900114.1499590340-1822901900.1499590340#api/2/workflowscheme-createScheme.
- [Update] action
-
Endpoint URL address:
/workflowscheme/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.256753803.1846900114.1499590340-1822901900.1499590340#api/2/workflowscheme-update.
- [Delete] action
-
Endpoint URL address:
/workflowscheme/{{=item.id}}.Documentation: https://docs.atlassian.com/jira/REST/cloud/?_ga=2.256753803.1846900114.1499590340-1822901900.1499590340#api/2/workflowscheme-deleteScheme.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- description
Template: LongText.
- defaultWorkflow
Template: ShortText.
- issueTypeMappings
Template: LongText. A composite field.
- originalDefaultWorkflow
Template: ShortText.
- originalIssueTypeMappings
Template: LongText. A composite field.
- draft
Data type: DT_BOOL
- lastModifiedUser
Template: User.
- lastModified
Template: DateTime.
- updateDraftIfNeeded
Data type: DT_BOOL
- issueTypes
The gathered value is processed with
{{=value && _.values(value)}}expression. Field components:- An array.
-
Uses template:
IssueType.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Number
Data type: DT_I4
- AssociatedItem
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, typeName, parentId, parentName.
-
Uses template:
- UrlsT
Field components:
-
Uses template:
ShortText. - Contains the following components: 16x16, 24x24, 32x32, 48x48.
-
Uses template:
- User
Field components:
-
Uses template:
ShortText. - Contains the following components: key, self, accountId, name, avatarUrls, displayName, active, emailAddress, timeZone, locale, groups, applicationRoles, expand.
-
Uses template:
- ComponentT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, self, name, description, lead, leadUserName, assigneeType, assignee, realAssigneeType, realAssignee, isAssigneeTypeValid, project, projectId.
-
Uses template:
- GroupT
Field components:
-
Uses template:
ShortText. - Contains the following components: name, self.
-
Uses template:
- RoleT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, self, name, description, actors.
-
Uses template:
- StatusCategoryT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, self, key, colorName, name.
-
Uses template:
- StatusT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, self, statusColor, description, iconUrl, name, statusCategory.
-
Uses template:
- FieldT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, key, name, custom, orderable, navigable, searchable, clauseNames, schema.
-
Uses template:
- NotificationSchemeT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, self, name, expand, description, notificationSchemeEvents.
-
Uses template:
- SchemePermission
Field components:
-
Uses template:
ShortText. - Contains the following components: id, self, holder, permission.
-
Uses template:
- PermissionSchemeT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, self, name, description, expand, permissions.
-
Uses template:
- VersionT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, self, expand, description, name, archived, released, overdue, userStartDate, userReleaseDate, project, projectId, moveUnfixedIssuesTo, operations, remotelinks.
-
Uses template:
- IssueType
Field components:
-
Uses template:
ShortText. - Contains the following components: id, self, description, iconUrl, name, subtask, avatarId, type.
-
Uses template:
- ProjectT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, self, expand, key, description, lead, url, email, assigneeType, name, avatarUrls, projectKeys, projectCategory, projectTypeKey, avatarId, categoryId.
-
Uses template:
- FilterPermission
Field components:
-
Uses template:
ShortText. - Contains the following components: id, type, project, role, group.
-
Uses template:
- FieldMeta
Field components:
-
Uses template:
ShortText. - Contains the following components: key, required, schema, name, autoCompleteUrl, hasDefaultValue, operations, allowedValues, defaultValue.
-
Uses template:
- MetadataParticipant
Field components:
-
Uses template:
ShortText. - Contains the following components: id, displayName, displayNameKey, type, avatarUrl, url.
-
Uses template:
- SimpleLink
Field components:
-
Uses template:
ShortText. - Contains the following components: id, styleClass, iconClass, label, title, href, weight.
-
Uses template:
- IconT
Field components:
-
Uses template:
ShortText. - Contains the following components: url16x16, title, link.
-
Uses template:
- TransitionT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, to, hasScreen, fields, expand.
-
Uses template:
- HistoryMetadataT
Field components:
-
Uses template:
ShortText. - Contains the following components: type, description, descriptionKey, activityDescription, activityDescriptionKey, emailDescription, emailDescriptionKey, actor, generator, cause, extraData.
-
Uses template:
- RemoteLinkT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, self, globalId, application, relationship, object.
-
Uses template:
- Comment
Field components:
-
Uses template:
ShortText. - Contains the following components: id, self, author, body, renderedBody, updateAuthor, created, updated, visibility, properties.
-
Uses template:
- Worklog
Field components:
-
Uses template:
ShortText. - Contains the following components: id, self, author, updateAuthor, comment, created, updated, visibility, started, timeSpent, timeSpentSeconds, issueId, properties.
-
Uses template:
- Progress
Field components:
- Contains the following components: progress, total.
- PriorityT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, self, statusColor, description, iconUrl.
-
Uses template:
- Votes
Field components:
-
Uses template:
ShortText. - Contains the following components: votes, hasVoted, self.
-
Uses template:
- Watches
Field components:
-
Uses template:
ShortText. - Contains the following components: watchCount, isWatching, self, watchers.
-
Uses template:
- ResolutionT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, self, name, description, iconUrl.
-
Uses template:
- TimeTracking
Field components:
-
Uses template:
ShortText. - Contains the following components: originalEstimate, remainingEstimate, timeSpent, originalEstimateSeconds, remainingEstimateSeconds, timeSpentSeconds.
-
Uses template:
- SecurityLevel
Field components:
-
Uses template:
ShortText. - Contains the following components: id, self, name, description.
-
Uses template:
- Attachment
Field components:
-
Uses template:
ShortText. - Contains the following components: id, self, filename, author, created, size, mimeType, contentUrl, content, thumbnail.
-
Uses template:
- IssueLinkType
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, inward, outward, self.
-
Uses template:
- IOLink
Field components:
-
Uses template:
ShortText. - Contains the following components: id, key, self, fields.
-
Uses template:
- IssueLinks
Field components:
-
Uses template:
ShortText. - Contains the following components: id, type, inwardIssue, outwardIssue.
-
Uses template:
- Select
Field components:
-
Uses template:
ShortText. - Contains the following components: value.
-
Uses template:
- CascadingSelect
Field components:
-
Uses template:
ShortText. - Contains the following components: value, child.
-
Uses template:
Knowledge Base
- What is the Certificate file parameter format when using OAuth authentication?
- Where can I find the documentation for the Jira Connection?
- How do I create a connection with the JIRA configuration?
- How to export key pair and certificate to .pfx file.
What's New
- New: Updated to use new Project read endpoint.
- Fixed: Corrected default service base url.
- New: Support for OAuth2 authentication.
- New: Support for
expandfield when querying Issue resource.
- Fixed: Authentication signature was invalid because of changes in the REST backend.
- Fixed: Failed to update fields of type 'option-with-child' (Thank you, Keerthi).
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.