Table of Contents

• Getting Started
  • Helpful Background Information
  • Prerequisites
  • External Dependencies
  • Adapters
  • How to Install
  • Testing
• Using this Workflow Project
  • Create Issue - Jira - REST
  • Create Project - Jira - REST
  • Transition Issue - Jira - REST
• Additional Information
  • Support

Getting Started

This section is helpful for deployments as it provides you with pertinent information on prerequisites and properties.

Helpful Background Information

Workflows often include logic that varies from business to business. As a result, we often find that our Workflow Projects are more useful as modular components that can be incorporated into a larger process. In addition, they often can add value as a learning tool on how we integrate with other systems and how we do things within the Itential Automation Platform.

While these can be utilized, you may find more value in using them as a starting point to build around.

Prerequisites

Itential Workflow Projects are built and tested on particular versions of IAP. In addition, Workflow Projects are often dependent on external systems and as such, these Workflow Projects will have dependencies on these other systems. This version of Atlassian - Jira - REST has been tested with:

• IAP 2023.2

External Dependencies

Adapters

How to Install

To install the Workflow Project:

• Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the Supported IAP Versions section in order to install the Example Project.
• Import the Example Project in Admin Essentials.

Testing

Cypress is generally used to test all Itential Example Projects. While Cypress is an opensource tool, at Itential we have internal libraries that have been built around Cypress to allow us to test with a deployed IAP.

When certifying our Example Projects for a release of IAP we run these tests against the particular version of IAP and create a release branch in GitLab. If you do not see the Example Project available in your version of IAP please contact Itential.

While Itential tests this Example Project and its capabilities, it is often the case the customer environments offer their own unique circumstances. Therefore, it is our recommendation that you deploy this Example Project into a development/testing environment in which you can test the Example Project.

Using this Workflow Project

Workflow Projects contain 1 or more workflows. Each of these workflows have different inputs and outputs.

Create Issue - Jira - REST

Create an issue in Jira

Capabilities include:

• Create an issue in Jira

Entry Point IAP Component

The primary IAP component to run Create Issue - Jira - REST is listed below:

Inputs

The following table lists the inputs for Create Issue - Jira - REST:

Jira

ADAPT

Bug in the new release

Application crashes on passing empty id

Bug

High

Hot

Outputs

The following table lists the outputs for Create Issue - Jira - REST:

{
  "id": "5600",
  "key": "ADAPT-3240",
  "self": "https://itential.atlassian.net/rest/api/2/issue/5600"
}

Query Output

The following items show how to query successful results from the output of Create Issue - Jira - REST:

id

createdIssue.response.id

key

createdIssue.response.key

self

createdIssue.response.self

Example Inputs and Outputs

Example 1

Input:

{
  "adapterId": "Jira",
  "projectKey": "ADAPT",
  "description": "Bug in the new release",
  "summary": "Application crashes on passing empty id",
  "issueType": "Bug",
  "priority": "High",
  "label": "Hot"
} 

Output:

{
      "id": "265600",
      "key": "ADAPT-3240",
      "self": "https://itential.atlassian.net/rest/api/2/issue/265600"
    } 

API Links

Create Project - Jira - REST

Create a project in Jira

Capabilities include:

• Create a project in Jira

Entry Point IAP Component

The primary IAP component to run Create Project - Jira - REST is listed below:

Inputs

The following table lists the inputs for Create Project - Jira - REST:

Jira

DEMO

software

com.pyxis.greenhopper.jira:gh-simplified-agility-kanban

DEMO

A project for software demo team

3112

PROJECT_LEAD

Outputs

The following table lists the outputs for Create Project - Jira - REST:

{
  "id": 32184,
  "key": "incident",
  "self": "https://MmvAESOynfzkMznAoRy9-mhyD"
}

Query Output

The following items show how to query successful results from the output of Create Project - Jira - REST:

id

result.response.id

key

result.response.key

self

result.response.self

Example Inputs and Outputs

Example 1

Input:

{
  "adapterId": "Jira",
  "name": "DEMO",
  "projectType": "software",
  "projectTemplateKey": "com.pyxis.greenhopper.jira:gh-simplified-agility-kanban",
  "abbreviatedName": "DEMO",
  "description": "Project for software demo team",
  "leadAccountId": "3112",
  "assigneeType": "PROJECT_LEAD"
} 

Output:

{
  "id": 32184,
  "key": "incident",
  "self": "https://MmvAESOynfzkMznAoRy9-mhyD"
} 

API Links

Transition Issue - Jira - REST

Transition an issue in Jira to a different status

Capabilities include:

• Transition an issue in Jira to a different status

Entry Point IAP Component

The primary IAP component to run Transition Issue - Jira - REST is listed below:

Inputs

The following table lists the inputs for Transition Issue - Jira - REST:

Jira

265416

Selected for Development

Outputs

The following table lists the outputs for Transition Issue - Jira - REST:

" "

Query Output

There are no query output examples for Transition Issue - Jira - REST.

Example Inputs and Outputs

Example 1

Input:

{
  "adapterId": "Jira",
  "issueIdOrKey": "265416",
  "transitionStatus": "Selected for Development"
} 

Output:

" " 

API Links

Additional Information

Support

Please use your Itential Customer Success account if you need support when using this Workflow Project.